Typescripts - #30
Conversation
Reviewer's Guide by SourceryThis pull request updates the repository URLs in package.json files, README files, and documentation to reflect the move of the codetypo-cli package to the main codetypo repository. It also updates the command used to create dictionaries and adds a new CLI package. Flow diagram of CLI package installation processgraph TD
A[Start Installation] --> B{Installation Method?}
B -->|NPM| C[npm install -g git+https://github.com/khulnasoft/codetypo]
B -->|Docker| D[docker pull ghcr.io/khulnasoft/codetypo]
C --> E[CLI Available as 'codetypo-cli']
D --> F[Run via Docker Container]
E --> G[End]
F --> G[End]
style A fill:#f5f5f5,stroke:#333,stroke-width:2px
style B fill:#e1f5fe,stroke:#333,stroke-width:2px
style C fill:#e8f5e9,stroke:#333,stroke-width:2px
style D fill:#e8f5e9,stroke:#333,stroke-width:2px
style E fill:#f5f5f5,stroke:#333,stroke-width:2px
style F fill:#f5f5f5,stroke:#333,stroke-width:2px
style G fill:#f5f5f5,stroke:#333,stroke-width:2px
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
WalkthroughThis pull request represents a comprehensive restructuring of the CodeTypo CLI project, consolidating the Changes
Sequence DiagramsequenceDiagram
participant User
participant CLI as CodeTypo CLI
participant Config as Configuration
participant Dictionary as Dictionary Service
User->>CLI: Execute command (lint/check/trace)
CLI->>Config: Load configuration
Config->>Dictionary: Retrieve dictionaries
Dictionary-->>CLI: Return word lists
CLI->>User: Display results/suggestions
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
CI Feedback 🧐(Feedback updated until commit b5fce51)A test triggered by this PR failed. Here is an AI-generated analysis of the failure:
|
github-actions
Bot
added
the
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 15
🧹 Nitpick comments (30)
packages/cli/docker/german/Dockerfile (1)
1-8: Add LABEL metadata for maintainability.Consider adding LABEL metadata to provide maintainer information and other relevant details about the image.
FROM ghcr.io/khulnasoft/codetypo:8.4.1 +LABEL maintainer="CodeTypo Team" +LABEL description="CodeTypo CLI with German language support" +LABEL version="1.0" WORKDIR /app ENV HOME=/homepackages/cli/.github/workflows/cspell-action.yml (1)
1-8: Add concurrency control to optimize workflow runs.Consider adding concurrency configuration to cancel outdated workflow runs and optimize GitHub Actions usage.
name: codetypo-action on: pull_request: push: branches: - main workflow_dispatch: +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: truepackages/cli/.pre-commit-hooks.yaml (1)
5-9: Consider adding version pinning for the hook.To ensure consistent behavior across different environments, consider adding a version specification for the hook.
- id: codetypo name: codetypo description: This hook runs CodeTypo spellchecker entry: codetypo-cli + rev: v1.0.0 # Add specific version language: nodepackages/cli/.github/actions/setup/action.yaml (2)
4-7: Consider adding Node version constraintsWhile the default of "18.x" is good, consider adding validation for minimum/maximum supported Node versions to prevent issues with incompatible versions.
node-version: required: false description: The version of Node to use. + pattern: "^1[68-9]\.x$|^20\.x$" # Supports Node 16-20 default: "18.x"
17-19: Add error handling for npm version checkThe npm version check could fail silently. Consider adding error handling.
- name: NPM Version - run: npm -v; + run: npm -v || exit 1; shell: bashpackages/cli/.github/workflows/codeql-analysis.yml (1)
23-26: Consider increasing fetch-depth for comprehensive analysisWhile 20 commits might be sufficient in most cases, CodeQL benefits from deeper history for better analysis. Consider increasing the fetch depth.
with: - fetch-depth: 20 + fetch-depth: 0 # Fetch full history for better analysispackages/cli/static/help-check.txt (2)
6-7: Fix formatting inconsistencyThere's an extra space after "use." and missing comma after "By default".
- Configuration file to use. By default codetypo + Configuration file to use. By default, codetypo🧰 Tools
🪛 LanguageTool
[uncategorized] ~6-~6: Did you mean: “By default,”?
Context: ...typo.json> Configuration file to use. By default codetypo ...(BY_DEFAULT_COMMA)
1-15: Add usage examples sectionThe help text would benefit from including common usage examples to help users get started quickly.
Add an "Examples:" section at the end:
Examples: $ codetypo check README.md $ codetypo check --no-color src/**/*.md $ codetypo check --config custom-config.json docs/🧰 Tools
🪛 LanguageTool
[uncategorized] ~6-~6: Did you mean: “By default,”?
Context: ...typo.json> Configuration file to use. By default codetypo ...(BY_DEFAULT_COMMA)
packages/cli/.github/actions/github-app-token/action.yaml (1)
10-12: Add input validation for private keyConsider adding pattern validation for the private key format to prevent invalid inputs.
app_private_key: description: Application Private Key used to sign the PR required: true + pattern: "^-----BEGIN RSA PRIVATE KEY-----[\\s\\S]*-----END RSA PRIVATE KEY-----$"packages/cli/.github/workflows/release-please.yml (1)
14-54: Add workflow timeouts and concurrency controlsConsider adding timeout limits and concurrency controls to prevent long-running or conflicting workflow runs.
Add at the workflow level:
concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: release-please: timeout-minutes: 15 # ... rest of the job config publish: timeout-minutes: 15 # ... rest of the job config publish-docker: timeout-minutes: 30 # ... rest of the job configpackages/cli/static/help-trace.txt (1)
6-7: Minor grammatical improvement neededAdd a comma after "By default" for better readability.
- -c, --config <codetypo.json> Configuration file to use. By default codetypo + -c, --config <codetypo.json> Configuration file to use. By default, codetypo🧰 Tools
🪛 LanguageTool
[uncategorized] ~6-~6: Did you mean: “By default,”?
Context: ...typo.json> Configuration file to use. By default codetypo ...(BY_DEFAULT_COMMA)
packages/cli/.github/workflows/update-dependabot.yml (2)
14-15: Consider adding more granular permissionsThe workflow currently only has
contents: readpermission. For creating PRs via the GitHub App token, consider explicitly declaring required permissions.permissions: contents: read + pull-requests: write
47-48: Consider adding prettier configuration fileThe workflow uses prettier to format dependabot.yml but doesn't specify a configuration. Consider adding a
.prettierrcfile to ensure consistent formatting across the project.packages/cli/.github/workflows/test.yml (2)
32-34: Add caching for npm dependenciesConsider adding caching for npm dependencies to improve workflow execution time.
+ - name: Cache dependencies + uses: actions/cache@v3 + with: + path: ~/.npm + key: npm-${{ runner.os }}-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }} + restore-keys: | + npm-${{ runner.os }}-${{ matrix.node-version }}- - run: npm -v - run: npm ci --omit=dev - run: npm test
71-72: Consider adding Docker layer cachingTo improve Docker build times in CI, consider using Docker layer caching.
+ - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Build and cache Docker image + uses: docker/build-push-action@v5 + with: + context: . + push: false + load: true + tags: codetypo:latest + cache-from: type=gha + cache-to: type=gha,mode=max - - run: docker build -t codetypo . - run: docker run -v $(pwd):/workdir codetypopackages/cli/.github/dependabot.yml (1)
8-32: Consider consolidating duplicate configurationsThe configurations for main and codetypo4 branches are identical except for the target branch. Consider using GitHub's branch protection rules instead of duplicate configurations.
packages/cli/package.json (2)
15-19: Consolidate version management scripts.Multiple version management scripts with similar functionality could be consolidated into a single script with arguments.
Consider this alternative approach:
- "version-prerelease": "npx version-release -p", - "version-release-minor": "npx standard-version -r minor", - "version-release-patch": "npx standard-version -r patch", - "version-release": "npx standard-version", + "version": "node scripts/version.js"Create a new
scripts/version.jsfile that handles all version types through command-line arguments.🧰 Tools
🪛 GitHub Actions: Website - Build and Test
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: codeTypo-cli
[error] Invalid package.json file structure detected. The file appears to be malformed or contains invalid JSON syntax.
🪛 GitHub Actions: Lint Docs
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Test - Build Docs
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Website - Lint
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Lint
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
🪛 GitHub Actions: 🧪 Test
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
54-55: Pin prettier version for consistency.The caret (^) in the prettier version allows for minor version updates which could lead to inconsistent formatting across different environments.
- "prettier": "^3.4.2" + "prettier": "3.4.2"🧰 Tools
🪛 GitHub Actions: Website - Build and Test
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: codeTypo-cli
[error] Invalid package.json file structure detected. The file appears to be malformed or contains invalid JSON syntax.
🪛 GitHub Actions: Lint Docs
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Test - Build Docs
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Website - Lint
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Lint
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
🪛 GitHub Actions: 🧪 Test
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
packages/cli/static/help-suggestions.txt (2)
6-8: Fix formatting in configuration file description.The description contains a double space after the period which is inconsistent with the rest of the documentation.
- Configuration file to use. By default + Configuration file to use. By default🧰 Tools
🪛 LanguageTool
[uncategorized] ~6-~6: Did you mean: “By default,”?
Context: ... Configuration file to use. By default ...(BY_DEFAULT_COMMA)
20-22: Improve clarity of --num-suggestions description.The description for
--num-suggestionscould be more descriptive about what kind of suggestions are being limited.- --num-suggestions <number> Number of suggestions (default: 8) + --num-suggestions <number> Maximum number of spelling suggestions to return (default: 8)packages/cli/docker/german/README.md (1)
42-57: Add language identifier to code block.The code block showing the trace command output is missing a language identifier.
-``` +```text Word F Dictionary Dictionary Location ...🧰 Tools
🪛 Markdownlint (0.37.0)
42-42: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
packages/cli/.github/workflows/update-cspell.yml (2)
19-19: Document the cron schedule.Add a comment to explain why the cron job runs at 7:00 UTC daily.
Apply this diff:
- - cron: "0 7 * * *" + # Run daily at 7:00 UTC to catch updates early in the workday + - cron: "0 7 * * *"
129-139: Add PR labels for better visibility.Add labels to the PR to indicate the type of change (fix/feat) and that it's an automated update.
Apply this diff:
with: commit-message: "${{ env.PR_TYPE }}: ${{ steps.commit_message.outputs.value }}" branch: ${{ env.NEW_BRANCH }} base: ${{ env.REF_BRANCH }} title: "${{ env.PR_TYPE }}: ${{ steps.commit_message.outputs.value }}" body: ${{ steps.body.outputs.body }} + labels: | + ${{ env.PR_TYPE }} + automated-pr + dependencies app_id: ${{ secrets.AUTOMATION_APP_ID }} app_private_key: ${{ secrets.AUTOMATION_PRIVATE_KEY }}packages/cli/README.md (3)
7-9: Add language specifiers to code blocks.Add language specifiers to fenced code blocks for better syntax highlighting.
Apply these changes:
- Line 7: Add
shellto the code block- Line 74: Add
shellto the code block- Line 94: Add
textto the code block- Line 126: Add
textto the code block- Line 242: Add
textto the code block- Line 279: Add
textto the code block- Line 305: Add
textto the code block- Line 349: Add
textto the code blockAlso applies to: 74-76, 94-96, 126-126, 242-242, 279-279, 305-305, 349-349
🧰 Tools
🪛 Markdownlint (0.37.0)
7-7: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
88-88: Fix duplicate heading.The "Usage" heading appears twice in the document. Consider renaming the second instance to be more specific.
Apply this diff:
-## Usage +## Command Reference🧰 Tools
🪛 Markdownlint (0.37.0)
88-88: null
Multiple headings with the same content(MD024, no-duplicate-heading)
372-372: Fix grammar in versioning note.The phrase "independently from" should be "independently of" for correct grammar.
Apply this diff:
-`minor` and `patch` versioning goes up independently from `codetypo`. +`minor` and `patch` versioning goes up independently of `codetypo`.🧰 Tools
🪛 LanguageTool
[grammar] ~372-~372: The usual collocation for “independently” is “of”, not “from”. Did you mean “independently of”?
Context: ...minorandpatchversioning goes up independently fromcodetypo. Where possible, theminor...(INDEPENDENTLY_FROM_OF)
docs/_includes/generated-docs/README.md (1)
54-56: Improve grammar in the example installation instruction.The sentence structure needs improvement.
Apply this change:
-Example install: `npm install -g git+https://github.com/khulnasoft/codetypo`. +Example installation command: `npm install -g git+https://github.com/khulnasoft/codetypo`🧰 Tools
🪛 LanguageTool
[grammar] ~56-~56: There seems to be a noun/verb agreement error. Did you mean “installs” or “installed”?
Context: ...etypodirectly from GitHub. Example install:npm install -g git+https://github.com...(SINGULAR_NOUN_VERB_AGREEMENT)
packages/cli/SECURITY.md (1)
13-17: Improve clarity in vulnerability reporting instructions.The current structure presents two reporting methods without clear prioritization, which might confuse users about which method to use first.
Apply this change to clarify the reporting hierarchy:
-To report a security vulnerability, please use the -[Tidelift security contact](https://tidelift.com/security). -Tidelift will coordinate the fix and disclosure. - -or send an email to [security@khulnasoft.com](mailto:security@khulnasoft.com) +To report a security vulnerability, please: + +1. Use the [Tidelift security contact](https://tidelift.com/security) (preferred method) + Tidelift will coordinate the fix and disclosure. + +2. Alternatively, send an email to [security@khulnasoft.com](mailto:security@khulnasoft.com)🧰 Tools
🪛 LanguageTool
[style] ~17-~17: Consider using “email”.
Context: ... coordinate the fix and disclosure. or send an email to [security@khulnasoft.com](mailto:securi...(SEND_AN_EMAIL)
packages/cli/static/help-lint.txt (1)
23-24: Improve formatting consistency in configuration description.The text needs consistent punctuation and spacing.
Apply this change:
- -c, --config <codetypo.json> Configuration file to use. By default codetypo - looks for codetypo.json in the current directory. + -c, --config <codetypo.json> Configuration file to use. By default, codetypo + looks for codetypo.json in the current directory🧰 Tools
🪛 LanguageTool
[uncategorized] ~23-~23: Did you mean: “By default,”?
Context: ...ypo.json> Configuration file to use. By default codetypo ...(BY_DEFAULT_COMMA)
README.md (1)
58-58: Consider adding a version tag to the installation command.While the updated repository link is correct, consider adding a version tag for stability:
-npm install -g git+https://github.com/khulnasoft/codetypo +npm install -g git+https://github.com/khulnasoft/codetypo#v8.0.0This ensures users install a stable, tested version rather than the latest potentially unstable commit.
🧰 Tools
🪛 LanguageTool
[grammar] ~58-~58: There seems to be a noun/verb agreement error. Did you mean “installs” or “installed”?
Context: ...etypodirectly from GitHub. Example install:npm install -g git+https://github.com...(SINGULAR_NOUN_VERB_AGREEMENT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
.DS_Storeis excluded by!**/.DS_Storedocs/.DS_Storeis excluded by!**/.DS_Storepackages/.DS_Storeis excluded by!**/.DS_Storetest-packages/.DS_Storeis excluded by!**/.DS_Store
📒 Files selected for processing (44)
README.md(1 hunks)codetypo.config.yaml(1 hunks)docs/_includes/generated-docs/README.md(1 hunks)package.json(1 hunks)packages/cli/.editorconfig(1 hunks)packages/cli/.github/FUNDING.yml(1 hunks)packages/cli/.github/actions/github-app-token/action.yaml(1 hunks)packages/cli/.github/actions/pr/action.yaml(1 hunks)packages/cli/.github/actions/setup/action.yaml(1 hunks)packages/cli/.github/dependabot.yml(1 hunks)packages/cli/.github/release.yml(1 hunks)packages/cli/.github/workflows/codeql-analysis.yml(1 hunks)packages/cli/.github/workflows/cspell-action.yml(1 hunks)packages/cli/.github/workflows/publish-docker-image.yml(1 hunks)packages/cli/.github/workflows/release-please.yml(1 hunks)packages/cli/.github/workflows/test.yml(1 hunks)packages/cli/.github/workflows/update-cspell.yml(1 hunks)packages/cli/.github/workflows/update-dependabot.yml(1 hunks)packages/cli/.github/workflows/update-dependencies.yml(1 hunks)packages/cli/.gitignore(1 hunks)packages/cli/.pre-commit-hooks.yaml(1 hunks)packages/cli/.prettierignore(1 hunks)packages/cli/.release-please-manifest.json(1 hunks)packages/cli/Dockerfile(1 hunks)packages/cli/LICENSE(1 hunks)packages/cli/README.md(1 hunks)packages/cli/SECURITY.md(1 hunks)packages/cli/codetypo.json(1 hunks)packages/cli/docker/german/Dockerfile(1 hunks)packages/cli/docker/german/README.md(1 hunks)packages/cli/docker/german/codetypo.config.yaml(1 hunks)packages/cli/index.js(1 hunks)packages/cli/package.json(1 hunks)packages/cli/release-please-config.json(1 hunks)packages/cli/static/help-check.txt(1 hunks)packages/cli/static/help-link.txt(1 hunks)packages/cli/static/help-lint.txt(1 hunks)packages/cli/static/help-suggestions.txt(1 hunks)packages/cli/static/help-trace.txt(1 hunks)packages/cli/static/help.txt(1 hunks)packages/codetypo/README.md(1 hunks)test-packages/codetypo/test-codetypo-cli/package.json(1 hunks)test-packages/codetypo/test-codetypo-esm-reporter/package.json(1 hunks)website/src/pages/index.md(1 hunks)
✅ Files skipped from review due to trivial changes (13)
- packages/cli/.prettierignore
- packages/cli/LICENSE
- packages/cli/index.js
- packages/cli/.release-please-manifest.json
- packages/cli/.github/release.yml
- packages/cli/.github/FUNDING.yml
- packages/cli/.editorconfig
- packages/cli/codetypo.json
- packages/cli/.gitignore
- packages/codetypo/README.md
- test-packages/codetypo/test-codetypo-cli/package.json
- packages/cli/release-please-config.json
- test-packages/codetypo/test-codetypo-esm-reporter/package.json
🧰 Additional context used
🪛 LanguageTool
packages/cli/static/help-check.txt
[uncategorized] ~6-~6: Did you mean: “By default,”?
Context: ...typo.json> Configuration file to use. By default codetypo ...
(BY_DEFAULT_COMMA)
packages/cli/static/help-trace.txt
[uncategorized] ~6-~6: Did you mean: “By default,”?
Context: ...typo.json> Configuration file to use. By default codetypo ...
(BY_DEFAULT_COMMA)
[uncategorized] ~21-~21: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ... Show all dictionaries. --only-found Show only dictionaries t...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
[uncategorized] ~23-~23: Possible missing comma found.
Context: ... Force color. --no-color Turn off color. --no...
(AI_HYDRA_LEO_MISSING_COMMA)
packages/cli/static/help-suggestions.txt
[uncategorized] ~6-~6: Did you mean: “By default,”?
Context: ... Configuration file to use. By default ...
(BY_DEFAULT_COMMA)
[duplication] ~24-~24: Possible typo: you repeated a word.
Context: ... Use stdin for input. --repl REPL interface for looking up ...
(ENGLISH_WORD_REPEAT_RULE)
docs/_includes/generated-docs/README.md
[grammar] ~56-~56: There seems to be a noun/verb agreement error. Did you mean “installs” or “installed”?
Context: ...etypodirectly from GitHub. Example install:npm install -g git+https://github.com...
(SINGULAR_NOUN_VERB_AGREEMENT)
packages/cli/README.md
[uncategorized] ~90-~90: Loose punctuation mark.
Context: .../README.md) ## Usage codetypo --help: <!--- @@Inject: static/help.txt ---> ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...default command. codetypo lint --help: <!--- @@Inject: static/help-lint.txt -...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...---> ### Trace codetypo trace --help: <!--- @@Inject: static/help-trace.txt ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~275-~275: Loose punctuation mark.
Context: ...---> ### Check codetypo check --help: <!--- @@Inject: static/help-check.txt ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~301-~301: Loose punctuation mark.
Context: ...ggestions codetypo suggestions --help: <!--- @@Inject: static/help-suggestion...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~345-~345: Loose punctuation mark.
Context: ...t ---> ### Link codetypo link --help: <!--- @@Inject: static/help-link.txt -...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~372-~372: The usual collocation for “independently” is “of”, not “from”. Did you mean “independently of”?
Context: ... minor and patch versioning goes up independently from codetypo. Where possible, the minor...
(INDEPENDENTLY_FROM_OF)
website/src/pages/index.md
[grammar] ~63-~63: There seems to be a noun/verb agreement error. Did you mean “installs” or “installed”?
Context: ...etypodirectly from GitHub. Example install:npm install -g git+https://github.com...
(SINGULAR_NOUN_VERB_AGREEMENT)
README.md
[grammar] ~58-~58: There seems to be a noun/verb agreement error. Did you mean “installs” or “installed”?
Context: ...etypodirectly from GitHub. Example install:npm install -g git+https://github.com...
(SINGULAR_NOUN_VERB_AGREEMENT)
packages/cli/SECURITY.md
[style] ~17-~17: Consider using “email”.
Context: ... coordinate the fix and disclosure. or send an email to [security@khulnasoft.com](mailto:securi...
(SEND_AN_EMAIL)
packages/cli/static/help-link.txt
[uncategorized] ~10-~10: “any” seems less likely than “and” (in addition to, following this).
Context: ...d|a <dictionaries...> Add dictionaries any other settings to the codetypo ...
(AI_HYDRA_LEO_CP_ANY_AND)
packages/cli/static/help-lint.txt
[grammar] ~18-~18: You can use the subjunctive mood in this context.
Context: ...//docs/doc.md Check stdin as if it was "./docs/doc.md" Check spelling Option...
(SUBJUNCTIVE_MOOD)
[uncategorized] ~23-~23: Did you mean: “By default,”?
Context: ...ypo.json> Configuration file to use. By default codetypo ...
(BY_DEFAULT_COMMA)
[grammar] ~31-~31: The negated form ‘not’ seems to be incomplete.
Context: ...y Only output the words not found in the ...
(DT_NN_NOT_VB)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ... dictionaries. -u, --unique Only output the first i...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~46-~46: Possible typo: you repeated a word.
Context: ...off summary message in console. -s, --silent Silent mode, suppress error messages. --no-e...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~69-~69: Possible missing comma found.
Context: ... .gitignore files. --no-gitignore Do NOT use .gitignore fil...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~73-~73: Possible missing comma found.
Context: ... Force color. --no-color Turn off color. --n...
(AI_HYDRA_LEO_MISSING_COMMA)
packages/cli/static/help.txt
[duplication] ~17-~17: Possible typo: you repeated a word.
Context: ......] Spelling Suggestions for words. link Link dictionaries and other settings to ...
(ENGLISH_WORD_REPEAT_RULE)
🪛 GitHub Actions: Website - Build and Test
package.json
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
packages/cli/package.json
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: codeTypo-cli
package.json
[error] Invalid package.json file structure detected. The file appears to be malformed or contains invalid JSON syntax.
packages/cli/package.json
[error] Invalid package.json file structure detected. The file appears to be malformed or contains invalid JSON syntax.
🪛 GitHub Actions: Lint Docs
package.json
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
packages/cli/package.json
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Test - Build Docs
package.json
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
packages/cli/package.json
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Website - Lint
package.json
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
packages/cli/package.json
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Lint
package.json
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
packages/cli/package.json
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
🪛 GitHub Actions: 🧪 Test
package.json
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
packages/cli/package.json
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
🪛 Markdownlint (0.37.0)
packages/cli/docker/german/README.md
42-42: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
packages/cli/README.md
88-88: null
Multiple headings with the same content
(MD024, no-duplicate-heading)
7-7: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
74-74: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
94-94: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
126-126: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
242-242: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
279-279: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
305-305: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
349-349: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (14)
packages/cli/docker/german/codetypo.config.yaml (1)
1-3: LGTM! Configuration looks good.The YAML configuration is valid and properly structured. The language codes follow ISO standards, and the addition of 'workdir' to recognized words aligns with the Docker configurations.
packages/cli/.github/actions/github-app-token/action.yaml (1)
20-20: LGTM! Good security practiceUsing a specific commit hash for the external action is a good security practice to prevent supply chain attacks.
packages/cli/static/help-trace.txt (1)
1-26: LGTM! Well-structured help documentation.The help documentation is comprehensive and follows standard CLI conventions. The command options are well-organized with clear descriptions.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~6-~6: Did you mean: “By default,”?
Context: ...typo.json> Configuration file to use. By default codetypo ...(BY_DEFAULT_COMMA)
[uncategorized] ~21-~21: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ... Show all dictionaries. --only-found Show only dictionaries t...(HYPHENATED_LY_ADVERB_ADJECTIVE)
[uncategorized] ~23-~23: Possible missing comma found.
Context: ... Force color. --no-color Turn off color. --no...(AI_HYDRA_LEO_MISSING_COMMA)
codetypo.config.yaml (1)
49-49: LGTM! Word list update aligns with repository changes.The addition of "khulnasoft" to the word list is consistent with the repository consolidation changes.
packages/cli/package.json (1)
27-27: Enhance test coverage.The test script
"test": "node ./index.js ."appears to be a minimal smoke test. Consider adding comprehensive test coverage including unit tests, integration tests, and end-to-end tests.Would you like me to help set up a more comprehensive test suite with Jest or another testing framework of your choice?
🧰 Tools
🪛 GitHub Actions: Website - Build and Test
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: codeTypo-cli
[error] Invalid package.json file structure detected. The file appears to be malformed or contains invalid JSON syntax.
🪛 GitHub Actions: Lint Docs
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Test - Build Docs
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Website - Lint
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Lint
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
🪛 GitHub Actions: 🧪 Test
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
packages/cli/.github/actions/pr/action.yaml (1)
60-60: Pin action to specific commit hash.Good practice! The action is correctly pinned to a specific commit hash rather than using a floating tag.
packages/cli/docker/german/README.md (1)
15-15: Pin package version for reproducible builds.The German dictionary package is pinned to a specific version which is good for reproducible builds.
packages/cli/.github/workflows/update-dependencies.yml (1)
23-23: Good security practice: Owner check.The job correctly checks the repository owner before running, preventing unauthorized execution.
packages/cli/.github/workflows/publish-docker-image.yml (2)
1-4: LGTM! Following GitHub's security best practices.The workflow follows the recommended practice of pinning actions to specific commit SHAs for security.
45-49: LGTM! Secure container registry authentication.The workflow correctly uses Docker's login-action with GitHub's token for secure authentication.
package.json (1)
25-25: LGTM! Script path updated correctly.The script path has been updated to use the new generator location.
🧰 Tools
🪛 GitHub Actions: Website - Build and Test
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: codeTypo-cli
[error] Invalid package.json file structure detected. The file appears to be malformed or contains invalid JSON syntax.
🪛 GitHub Actions: Lint Docs
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Test - Build Docs
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Website - Lint
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Lint
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
🪛 GitHub Actions: 🧪 Test
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
packages/cli/static/help.txt (1)
1-19: LGTM! Well-structured command documentation.The help text provides clear and comprehensive documentation of the available commands and options.
🧰 Tools
🪛 LanguageTool
[duplication] ~17-~17: Possible typo: you repeated a word.
Context: ......] Spelling Suggestions for words. link Link dictionaries and other settings to ...(ENGLISH_WORD_REPEAT_RULE)
packages/cli/static/help-lint.txt (1)
103-106: LGTM! Clear reference links.The reference links are properly formatted and point to the correct resources.
README.md (1)
56-56: LGTM! Repository link updated correctly.The link update aligns with the repository consolidation effort.
Let's verify the consistency of this link update across documentation:
✅ Verification successful
Repository links are consistently updated across all documentation
All references to the
codetypo-clirepository have been correctly updated to point tohttps://github.com/khulnasoft/codetypoin:
- README.md
- website/src/pages/index.md
- docs/_includes/generated-docs/README.md
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for any remaining references to the old repository rg -i "codetypo-cli" --type mdLength of output: 1574
Script:
#!/bin/bash # Check the exact URLs in documentation files rg -A 1 "codetypo-cli.*https" --type mdLength of output: 600
| RUN npm install @codetypo/dict-de-de@3.2.0 | ||
| RUN codetypo-cli link add @codetypo/dict-de-de |
There was a problem hiding this comment.
💡 Codebase verification
Update German dictionary package to latest version
The German dictionary package @codetypo/dict-de-de should be updated from version 3.2.0 to 4.0.3, which is the latest version available in the repository.
🔗 Analysis chain
Verify the German dictionary package version.
The German dictionary package is pinned to version 3.2.0. Let's verify if this is the latest stable version and check for any security advisories.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check npm registry for latest version and security advisories
npm view @codetypo/dict-de-de versions --json
npm audit @codetypo/dict-de-de@3.2.0
Length of output: 1146
Script:
#!/bin/bash
# Search for package.json files
fd package.json
# Look for any documentation about package sources
fd -e md -e txt | xargs rg -l "codetypo|dict-de-de"
# Check package.json contents for registry or repository information
fd package.json -x cat {}
Length of output: 68628
Script:
#!/bin/bash
# Check the German dictionary's package.json
cat dictionaries/de_DE/package.json
Length of output: 1902
| ENV HOME=/home | ||
| COPY package-lock.json package.json index.js ./ | ||
| RUN npm ci --omit=dev | ||
| RUN npm install --location=global |
There was a problem hiding this comment.
Verify global installation approach.
The global installation command lacks a specific package reference. This might lead to unexpected behavior.
-RUN npm install --location=global
+RUN npm install --location=global codetypo-cli@latest📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| RUN npm install --location=global | |
| RUN npm install --location=global codetypo-cli@latest |
| FROM node:18-alpine | ||
|
|
||
| WORKDIR /app | ||
| ENV HOME=/home | ||
| COPY package-lock.json package.json index.js ./ | ||
| RUN npm ci --omit=dev | ||
| RUN npm install --location=global |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider security and optimization improvements.
A few suggestions to enhance the Dockerfile:
- Use non-root user for better security
- Add .dockerignore to exclude unnecessary files
- Consider multi-stage build to reduce final image size
FROM node:18-alpine
+# Add .dockerignore file to exclude node_modules, .git, etc.
+
+# Create non-root user
+RUN addgroup -S codetypo && adduser -S codetypo -G codetypo
WORKDIR /app
ENV HOME=/home
COPY package-lock.json package.json index.js ./
+# Set correct ownership
+RUN chown -R codetypo:codetypo /app
+USER codetypo
RUN npm ci --omit=dev
-RUN npm install --location=global
+RUN npm install --location=global --unsafe-perm📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| FROM node:18-alpine | |
| WORKDIR /app | |
| ENV HOME=/home | |
| COPY package-lock.json package.json index.js ./ | |
| RUN npm ci --omit=dev | |
| RUN npm install --location=global | |
| FROM node:18-alpine | |
| # Add .dockerignore file to exclude node_modules, .git, etc. | |
| # Create non-root user | |
| RUN addgroup -S codetypo && adduser -S codetypo -G codetypo | |
| WORKDIR /app | |
| ENV HOME=/home | |
| COPY package-lock.json package.json index.js ./ | |
| # Set correct ownership | |
| RUN chown -R codetypo:codetypo /app | |
| USER codetypo | |
| RUN npm ci --omit=dev | |
| RUN npm install --location=global --unsafe-perm |
| - uses: actions/checkout@v4 | ||
| - uses: khulnasoft/codetypo-action@v6 |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Pin the action versions to SHA for security.
Using version tags for actions can be a security risk. Consider pinning to specific commit SHAs.
- - uses: actions/checkout@v4
- - uses: khulnasoft/codetypo-action@v6
+ - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4
+ - uses: khulnasoft/codetypo-action@5c2a8e2c7c0d32d51425b72d5224c0eb8326d664 # v6📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - uses: actions/checkout@v4 | |
| - uses: khulnasoft/codetypo-action@v6 | |
| - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4 | |
| - uses: khulnasoft/codetypo-action@5c2a8e2c7c0d32d51425b72d5224c0eb8326d664 # v6 |
| - name: Initialize CodeQL | ||
| uses: github/codeql-action/init@v3 | ||
| with: | ||
| languages: "javascript" |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider adding TypeScript language support
Since this is a TypeScript-related PR (based on the PR title "Typescripts"), consider adding TypeScript to the languages analyzed.
with:
- languages: "javascript"
+ languages: "javascript,typescript"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - name: Initialize CodeQL | |
| uses: github/codeql-action/init@v3 | |
| with: | |
| languages: "javascript" | |
| - name: Initialize CodeQL | |
| uses: github/codeql-action/init@v3 | |
| with: | |
| languages: "javascript,typescript" |
| export CODETYPO_VERSION=$(jq -r ".dependencies.codetypo | sub(\"[_^]\"; \"\")" package.json) | ||
| echo CODETYPO_VERSION=$CODETYPO_VERSION >> $GITHUB_ENV |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add version validation.
The version extraction from package.json should include validation to ensure the version exists and follows semantic versioning.
Apply this diff to add version validation:
-export CODETYPO_VERSION=$(jq -r ".dependencies.codetypo | sub(\"[_^]\"; \"\")" package.json)
-echo CODETYPO_VERSION=$CODETYPO_VERSION >> $GITHUB_ENV
+VERSION=$(jq -r ".dependencies.codetypo | sub(\"[_^]\"; \"\")" package.json)
+if [[ ! $VERSION =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$ ]]; then
+ echo "Error: Invalid version format: $VERSION"
+ exit 1
+fi
+echo CODETYPO_VERSION=$VERSION >> $GITHUB_ENV📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| export CODETYPO_VERSION=$(jq -r ".dependencies.codetypo | sub(\"[_^]\"; \"\")" package.json) | |
| echo CODETYPO_VERSION=$CODETYPO_VERSION >> $GITHUB_ENV | |
| VERSION=$(jq -r ".dependencies.codetypo | sub(\"[_^]\"; \"\")" package.json) | |
| if [[ ! $VERSION =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$ ]]; then | |
| echo "Error: Invalid version format: $VERSION" | |
| exit 1 | |
| fi | |
| echo CODETYPO_VERSION=$VERSION >> $GITHUB_ENV |
| echo CODETYPO_MINOR_OLD=$(echo '"${{ env.CODETYPO_VERSION_OLD }}"' | jq 'sub("\\.[0-9]+$";"")') >> $GITHUB_ENV | ||
| echo CODETYPO_MINOR_NEW=$(echo '"${{ env.CODETYPO_VERSION }}"' | jq 'sub("\\.[0-9]+$";"")') >> $GITHUB_ENV |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add version change validation.
The version comparison should validate that the new version is greater than the old version.
Apply this diff:
-echo CODETYPO_MINOR_OLD=$(echo '"${{ env.CODETYPO_VERSION_OLD }}"' | jq 'sub("\\.[0-9]+$";"")') >> $GITHUB_ENV
-echo CODETYPO_MINOR_NEW=$(echo '"${{ env.CODETYPO_VERSION }}"' | jq 'sub("\\.[0-9]+$";"")') >> $GITHUB_ENV
+# Extract and validate versions
+OLD_VER=${{ env.CODETYPO_VERSION_OLD }}
+NEW_VER=${{ env.CODETYPO_VERSION }}
+if ! dpkg --compare-versions "$NEW_VER" gt "$OLD_VER"; then
+ echo "Error: New version ($NEW_VER) is not greater than old version ($OLD_VER)"
+ exit 1
+fi
+echo CODETYPO_MINOR_OLD=$(echo "\"$OLD_VER\"" | jq 'sub("\\.[0-9]+$";"")') >> $GITHUB_ENV
+echo CODETYPO_MINOR_NEW=$(echo "\"$NEW_VER\"" | jq 'sub("\\.[0-9]+$";"")') >> $GITHUB_ENV📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| echo CODETYPO_MINOR_OLD=$(echo '"${{ env.CODETYPO_VERSION_OLD }}"' | jq 'sub("\\.[0-9]+$";"")') >> $GITHUB_ENV | |
| echo CODETYPO_MINOR_NEW=$(echo '"${{ env.CODETYPO_VERSION }}"' | jq 'sub("\\.[0-9]+$";"")') >> $GITHUB_ENV | |
| # Extract and validate versions | |
| OLD_VER=${{ env.CODETYPO_VERSION_OLD }} | |
| NEW_VER=${{ env.CODETYPO_VERSION }} | |
| if ! dpkg --compare-versions "$NEW_VER" gt "$OLD_VER"; then | |
| echo "Error: New version ($NEW_VER) is not greater than old version ($OLD_VER)" | |
| exit 1 | |
| fi | |
| echo CODETYPO_MINOR_OLD=$(echo "\"$OLD_VER\"" | jq 'sub("\\.[0-9]+$";"")') >> $GITHUB_ENV | |
| echo CODETYPO_MINOR_NEW=$(echo "\"$NEW_VER\"" | jq 'sub("\\.[0-9]+$";"")') >> $GITHUB_ENV |
| - [codetypo-cli](https://github.com/khulnasoft/codetypo) -- `codetypo-cli` is useful for including `codetypo` directly from GitHub. | ||
|
|
||
| Example install: `npm install -g git+https://github.com/khulnasoft/codetypo-cli`. | ||
| Example install: `npm install -g git+https://github.com/khulnasoft/codetypo`. |
There was a problem hiding this comment.
💡 Codebase verification
Documentation needs updates for the installation command
The current installation command has issues:
- It uses a git URL instead of the published npm package name
- The binary name in the documentation (
codetypo) doesn't match the actual binary name (codetypo-cli)
The correct installation command should be:
npm install -g codetypo-cli
🔗 Analysis chain
Verify the installation command works with the new repository structure.
The installation command has been updated to point to the new repository location. Let's verify that the command works correctly.
Run the following script to verify the installation command:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that the package can be installed from the new repository location.
# Test: Check if package.json exists in the expected location
if ! fd -t f "package.json" packages/cli/; then
echo "Error: package.json not found in packages/cli/"
exit 1
fi
# Test: Check if the package has the correct name and bin entries
jq -e '.name == "codetypo-cli" and .bin and .bin.codetypo' packages/cli/package.json > /dev/null
Length of output: 149
Script:
#!/bin/bash
# Display relevant package.json fields and verify binary
echo "=== Package.json contents ==="
jq '{name, version, bin, repository, main}' packages/cli/package.json
echo -e "\n=== Binary file check ==="
# Get binary path from package.json and check if it exists
BINARY_PATH=$(jq -r '.bin.codetypo' packages/cli/package.json)
if [ -n "$BINARY_PATH" ]; then
echo "Binary path from package.json: $BINARY_PATH"
# Check if the file exists relative to package.json location
if [ -f "packages/cli/$BINARY_PATH" ]; then
echo "Binary file exists"
else
echo "Binary file not found"
fi
else
echo "Binary path not defined in package.json"
fi
Length of output: 708
Script:
#!/bin/bash
# Check if the binary file exists and has correct permissions
echo "=== Binary file check ==="
if [ -f "packages/cli/index.js" ]; then
echo "Binary file exists"
ls -l packages/cli/index.js
else
echo "Binary file not found"
fi
# Show the actual package name for npm install
echo -e "\n=== Package name from package.json ==="
jq -r '.name' packages/cli/package.json
Length of output: 387
🧰 Tools
🪛 LanguageTool
[grammar] ~63-~63: There seems to be a noun/verb agreement error. Did you mean “installs” or “installed”?
Context: ...etypodirectly from GitHub. Example install:npm install -g git+https://github.com...
(SINGULAR_NOUN_VERB_AGREEMENT)
| "create-dictionary": "node ./generator-codetypo-dicts/run.js", | ||
| "#update-dictionaries": "# Update dictionaries will run the update-dictionary script in each dictionary package.", | ||
| "update-dictionaries": "pnpm -r run --stream --workspace-concurrency 2 update-dictionary", | ||
| "update:contributors": "update-contributors $(gh auth token)",, |
There was a problem hiding this comment.
Fix JSON syntax error causing pipeline failures.
There is an extra comma after "update:contributors" script that is causing JSON syntax errors and pipeline failures.
Apply this diff to fix the syntax error:
- "update:contributors": "update-contributors $(gh auth token)",,
+ "update:contributors": "update-contributors $(gh auth token)",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "update:contributors": "update-contributors $(gh auth token)",, | |
| "update:contributors": "update-contributors $(gh auth token)", |
🧰 Tools
🪛 Biome (1.9.4)
[error] 28-28: Expected a property but instead found ','.
Expected a property here.
(parse)
🪛 GitHub Actions: Website - Build and Test
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: codeTypo-cli
[error] Invalid package.json file structure detected. The file appears to be malformed or contains invalid JSON syntax.
🪛 GitHub Actions: Lint Docs
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Test - Build Docs
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Website - Lint
[error] JSON syntax error: Expected double-quoted property name at position 1612. Property names in JSON must be enclosed in double quotes.
🪛 GitHub Actions: Lint
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
🪛 GitHub Actions: 🧪 Test
[error] JSON syntax error: Expected double-quoted property name at position 1612. Ensure all property names in the JSON file are enclosed in double quotes.
| add|a <dictionaries...> Add dictionaries any other settings to the codetypo | ||
| global config. |
There was a problem hiding this comment.
Fix grammatical error in command description.
The description has a missing conjunction.
Apply this change:
- add|a <dictionaries...> Add dictionaries any other settings to the codetypo
+ add|a <dictionaries...> Add dictionaries and other settings to the codetypo📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| add|a <dictionaries...> Add dictionaries any other settings to the codetypo | |
| global config. | |
| add|a <dictionaries...> Add dictionaries and other settings to the codetypo | |
| global config. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: “any” seems less likely than “and” (in addition to, following this).
Context: ...d|a <dictionaries...> Add dictionaries any other settings to the codetypo ...
(AI_HYDRA_LEO_CP_ANY_AND)
1 participant
Notes for Reviewers
This PR fixes #
Signed commits
Summary by Sourcery
Update the repository URL in package.json files and documentation, and fix a typo in the codetypo.config.yaml file.
Enhancements:
Documentation:
Chores:
Summary by CodeRabbit
Based on the comprehensive summary of changes, here are the release notes:
New Features
lint,trace,check,suggestions, andlinkDocumentation
Infrastructure
codetypo-clitocodetypoConfiguration
These release notes provide a high-level overview of the significant changes while maintaining confidentiality about internal implementation details.