Skip to content

Code quality improvements: Remove unused configs and enhance syntax highlighting - #113

Merged
dborgards merged 5 commits into
mainfrom
claude/review-code-quality-01Tu9FGnQhvMz3AWjVasrABc
Nov 28, 2025
Merged

Code quality improvements: Remove unused configs and enhance syntax highlighting#113
dborgards merged 5 commits into
mainfrom
claude/review-code-quality-01Tu9FGnQhvMz3AWjVasrABc

Conversation

@dborgards

Copy link
Copy Markdown
Owner
  • Remove unused TypeScript and ESLint configuration files (tsconfig.json, .eslintrc.json, eslint.config.mjs)
    as this is a pure syntax highlighting extension with no TypeScript/JavaScript code
  • Remove lint.yml workflow since there are no source files to lint
  • Remove ESLint-related devDependencies from package.json
  • Complete CHANGELOG.md with detailed version 0.0.1 release notes
  • Add numeric literal support to MarScript grammar:
    • Hexadecimal numbers (0x1A2B)
    • Binary numbers (0b1010)
    • Floating-point numbers (123.45, 1.23e-4)
    • Integer numbers with optional scientific notation

These changes simplify the project structure and improve syntax highlighting capabilities.

…ighlighting

- Remove unused TypeScript and ESLint configuration files (tsconfig.json, .eslintrc.json, eslint.config.mjs)
  as this is a pure syntax highlighting extension with no TypeScript/JavaScript code
- Remove lint.yml workflow since there are no source files to lint
- Remove ESLint-related devDependencies from package.json
- Complete CHANGELOG.md with detailed version 0.0.1 release notes
- Add numeric literal support to MarScript grammar:
  * Hexadecimal numbers (0x1A2B)
  * Binary numbers (0b1010)
  * Floating-point numbers (123.45, 1.23e-4)
  * Integer numbers with optional scientific notation

These changes simplify the project structure and improve syntax highlighting capabilities.
Add explicit CodeQL workflow that documents this is a pure syntax
highlighting extension with only JSON configuration files and no
JavaScript/TypeScript source code to analyze.

This prevents CodeQL from failing when trying to analyze non-existent
JS/TS code and clearly communicates the project structure.

Fixes: CodeQL error "no source code for JavaScript/TypeScript"
- Remove custom CodeQL workflow to avoid conflicts with GitHub's Default setup
- Add "Project Structure" section to README documenting this is a pure
  syntax highlighting extension with only JSON configuration files
- Add maintainer note about disabling CodeQL Default setup in repo settings
- Update features list to include numeric literals support

The CodeQL Default setup should be disabled in repository settings since
this project contains no JavaScript/TypeScript source code to analyze.
Create a custom CodeQL workflow that explicitly handles this project's
structure as a pure JSON configuration project with no source code:

- Add .github/workflows/codeql.yml workflow that initializes CodeQL for
  javascript-typescript (as expected by GitHub) but uses a config file
  to exclude all paths from scanning
- Add .github/codeql-config.yml that explicitly excludes all file types
  and only includes non-existent src/** directory
- This prevents the "no source code found" error while satisfying GitHub's
  CodeQL requirements

The workflow will run successfully but perform no actual code analysis,
which is appropriate for this syntax highlighting extension.
CodeQL cannot be configured via workflow to handle a project with zero
source code files. Multiple approaches were attempted:
- Custom workflow with empty language matrix
- Config file excluding all paths
- Workflow with path exclusions

All approaches failed because CodeQL's database finalization requires
actual source code to exist, even if excluded from scanning.

Solution:
- Remove all CodeQL workflow and config files
- Add detailed step-by-step instructions in README for maintainers
  to manually disable CodeQL Default setup in GitHub repository settings
- Document why this is necessary (project previously had TS config files,
  triggering auto-detection)

This is the only reliable solution for a pure JSON configuration project
with no actual source code.

@dborgards dborgards left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@dborgards
dborgards merged commit 76f479c into main Nov 28, 2025
3 of 4 checks passed
@dborgards
dborgards deleted the claude/review-code-quality-01Tu9FGnQhvMz3AWjVasrABc branch November 28, 2025 15:13
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants