Conversation
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR updates project tooling/configuration and small internal behaviors to align with new linting and documentation expectations, while keeping the CLI’s runtime behavior consistent.
Changes:
- Switch internal “not resolved” sentinel from
nulltoundefinedin the import resolver and update tests accordingly. - Add
eslint-plugin-unicornto ESLint config and adjust ignores (includecoverage), plus dependency bumps. - Add repository governance/security docs (SECURITY policy, Code of Conduct) and add a dedicated coverage workflow.
Reviewed changes
Copilot reviewed 16 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| test/resolver.test.ts | Updates expectations from null to undefined for unresolved imports. |
| test/output/plain.format.test.ts | Adjusts test callsite for optional format parameter. |
| src/domains/pipeline/resolver.ts | Returns undefined instead of null; minor refactor to candidate path set creation. |
| src/domains/parsers/parser-type.ts | Adds block scoping for switch cases (formatting/structure). |
| src/domains/parsers/extractor.ts | Adds block scoping for switch cases (formatting/structure). |
| src/domains/output/markdown.format.ts | Renames fence helper and rewrites longest-run computation with a loop. |
| src/domains/output/formatter.ts | Makes format parameter optional in the public function signature and helper. |
| package.json | Adds eslint-plugin-unicorn and bumps dev tooling versions. |
| package-lock.json | Lockfile updates corresponding to dependency changes. |
| eslint.config.ts | Enables unicorn recommended config, disables a couple rules, and ignores coverage. |
| SECURITY.md | Adds security policy and reporting instructions. |
| README.md | Wraps prose to match new Prettier prose settings. |
| CONTRIBUTING.md | Updates contributing guidance and references Code of Conduct + Security Policy. |
| CODE-OF-CONDUCT.md | Adds Contributor Covenant 3.0 Code of Conduct. |
| .prettierrc.json | Sets proseWrap: "always" for consistent markdown wrapping. |
| .github/workflows/coverage.yml | Adds a dedicated workflow to run tests with coverage and upload to Codecov. |
| .github/workflows/code-quality.yml | Removes embedded coverage upload step (coverage handled by new workflow). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This pull request introduces several improvements focused on project documentation, code quality workflows, and developer tooling. Key updates include the addition of a Code of Conduct and Security Policy, enhancements to the contributing guide, separation of code quality and coverage workflows, and minor code and documentation corrections.
Documentation and Community Guidelines
CODE-OF-CONDUCT.mdbased on Contributor Covenant 3.0 to define community standards and enforcement procedures.SECURITY.mdfile outlining the process for reporting vulnerabilities and the project's security support policy.CONTRIBUTING.mdto reference the new Code of Conduct, clarify the contribution process, add a security reporting section, and refine expectations for PR focus and review. [1] [2] [3] [4]README.mdfor clarity, updated usage examples to usesrc/bin.tsinstead ofsrc/entrypoint.ts, and reformatted for readability. [1] [2] [3] [4] [5] [6] [7]CI/CD and Code Quality Workflows
code-quality.ymlnow only runs lint/build, while a newcoverage.ymlhandles test coverage and Codecov uploads. [1] [2] [3]Developer Tooling and Configuration
eslint-plugin-unicornwith recommended rules, and disabled specific unicorn rules for project compatibility. Also, updated ignored paths for ESLint.proseWrap: "always"to.prettierrc.jsonfor improved markdown formatting.package.json, switched CLI entrypoint references fromentrypoint.jstobin.js, and updated related scripts. [1] [2]Codebase Corrections and Minor Refactoring
Type of change
Validation
npm run format:checknpm run lintnpm run typechecknpm run knipnpm testnpm run buildChecklist
main.