-
Notifications
You must be signed in to change notification settings - Fork 0
chore: apply ultracite fixes and harden README generation/tests #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
132937e
d973133
3da1fb4
97c2314
766a844
5dcac6c
93ab5a3
82356f4
e9ca159
80e6f26
f44d702
28d4b2b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,5 @@ | ||||||
| --- | ||||||
| "readie": patch | ||||||
| --- | ||||||
|
|
||||||
| Added ultracte to readie | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix spelling: “ultracte” → “ultracite”. Spelling error flagged by LanguageTool; please correct the word in the changeset entry. ✍️ Proposed fix-Added ultracte to readie
+Added ultracite to readie📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool[grammar] ~5-~5: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) 🪛 markdownlint-cli2 (0.21.0)[warning] 5-5: First line in a file should be a top-level heading (MD041, first-line-heading, first-line-h1) 🤖 Prompt for AI Agents |
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| // Ultracite oxfmt Configuration | ||
| // https://oxc.rs/docs/guide/usage/formatter/config-file-reference.html | ||
| { | ||
| "$schema": "./node_modules/oxfmt/configuration_schema.json", | ||
| "printWidth": 80, | ||
| "tabWidth": 2, | ||
| "useTabs": true, | ||
| "semi": true, | ||
| "singleQuote": false, | ||
| "quoteProps": "as-needed", | ||
| "jsxSingleQuote": false, | ||
| "trailingComma": "es5", | ||
| "bracketSpacing": true, | ||
| "bracketSameLine": false, | ||
| "arrowParens": "always", | ||
| "endOfLine": "lf", | ||
| "experimentalSortPackageJson": true, | ||
| "experimentalSortImports": { | ||
| "ignoreCase": true, | ||
| "newlinesBetween": true, | ||
| "order": "asc", | ||
| }, | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "$schema": "./node_modules/oxlint/configuration_schema.json", | ||
| "extends": ["./node_modules/ultracite/config/oxlint/core/.oxlintrc.json"] | ||
| } |
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,21 @@ | ||
| { | ||
| "$schema": "https://unpkg.com/readie/schemas/readie.schema.json", | ||
| "version": "1", | ||
| "title": "Acme Toolkit", | ||
| "description": "A TypeScript toolkit for building internal tools.", | ||
| "includeTableOfContents": true, | ||
| "badges": [ | ||
| { | ||
| "label": "npm", | ||
| "image": "https://img.shields.io/npm/v/acme-toolkit.svg", | ||
| "link": "https://www.npmjs.com/package/acme-toolkit" | ||
| } | ||
| ], | ||
| "features": [ | ||
| "Typed APIs", | ||
| "Fast local setup", | ||
| "Works in Node.js and Bun" | ||
| ], | ||
| "installation": [ | ||
| "```bash\nnpm install acme-toolkit\n```" | ||
| ], | ||
| "usage": [ | ||
| "Import the toolkit and initialize your client.", | ||
| "```ts\nimport { createClient } from 'acme-toolkit'\n\nconst client = createClient()\n```" | ||
| ], | ||
| "support": [ | ||
| "Open an issue in your repository tracker." | ||
| ] | ||
| "$schema": "https://unpkg.com/readie/schemas/readie.schema.json", | ||
| "version": "1", | ||
| "title": "Acme Toolkit", | ||
| "description": "A TypeScript toolkit for building internal tools.", | ||
| "includeTableOfContents": true, | ||
| "badges": [ | ||
| { | ||
| "label": "npm", | ||
| "image": "https://img.shields.io/npm/v/acme-toolkit.svg", | ||
| "link": "https://www.npmjs.com/package/acme-toolkit" | ||
| } | ||
| ], | ||
| "features": ["Typed APIs", "Fast local setup", "Works in Node.js and Bun"], | ||
| "installation": ["```bash\nnpm install acme-toolkit\n```"], | ||
| "usage": [ | ||
| "Import the toolkit and initialize your client.", | ||
| "```ts\nimport { createClient } from \"acme-toolkit\";\n\nconst client = createClient();\n```" | ||
| ], | ||
| "support": ["Open an issue in your repository tracker."] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| pre-commit: | ||
| jobs: | ||
| - run: bun x ultracite fix | ||
| glob: | ||
| - "**/*.js" | ||
| - "**/*.jsx" | ||
| - "**/*.ts" | ||
| - "**/*.tsx" | ||
| - "**/*.json" | ||
| - "**/*.jsonc" | ||
| - "**/*.css" | ||
| stage_fixed: true |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,76 @@ | ||
| { | ||
| "name": "readie", | ||
| "version": "0.0.1", | ||
| "description": "Generate high-quality README files from a validated JSON config.", | ||
| "type": "module", | ||
| "main": "dist/index.js", | ||
| "bin": { | ||
| "readie": "dist/index.js" | ||
| }, | ||
| "files": [ | ||
| "dist", | ||
| "schemas", | ||
| "README.md", | ||
| "LICENSE", | ||
| "CHANGELOG.md", | ||
| "CONTRIBUTING.md", | ||
| "CODE_OF_CONDUCT.md", | ||
| "SECURITY.md" | ||
| ], | ||
| "scripts": { | ||
| "build": "bun build src/index.ts --outdir dist --target node --minify", | ||
| "clean": "bun --eval \"import { rmSync } from 'node:fs'; rmSync('dist', { recursive: true, force: true });\"", | ||
| "dev": "bun run src/index.ts", | ||
| "test": "bunx vitest run", | ||
| "test:watch": "bunx vitest", | ||
| "typecheck": "bunx tsc -p tsconfig.json --noEmit", | ||
| "prepare": "bun run build", | ||
| "changeset": "changeset" | ||
| }, | ||
| "keywords": [ | ||
| "readme", | ||
| "documentation", | ||
| "cli", | ||
| "generator", | ||
| "markdown" | ||
| ], | ||
| "author": "Christopher Burns", | ||
| "license": "MIT", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/consentdotio/readie.git" | ||
| }, | ||
| "homepage": "https://github.com/consentdotio/readie", | ||
| "bugs": { | ||
| "url": "https://github.com/consentdotio/readie/issues" | ||
| }, | ||
| "dependencies": { | ||
| "@effect/cli": "^0.73.2", | ||
| "@effect/platform": "^0.94.5", | ||
| "@effect/platform-node": "^0.104.1", | ||
| "@effect/printer": "^0.47.0", | ||
| "@effect/printer-ansi": "^0.47.0", | ||
| "effect": "^3.19.16" | ||
|
|
||
| }, | ||
| "devDependencies": { | ||
| "@types/node": "^24.3.0", | ||
| "typescript": "^5.9.2", | ||
| "vitest": "^3.2.4", | ||
| "@changesets/changelog-github": "^0.5.1", | ||
| "@changesets/cli": "^2.29.7", | ||
| "changeset-conventional-commits": "^0.2.5" | ||
| } | ||
| "name": "readie", | ||
| "version": "0.0.1", | ||
| "description": "Generate high-quality README files from a validated JSON config.", | ||
| "keywords": [ | ||
| "cli", | ||
| "documentation", | ||
| "generator", | ||
| "markdown", | ||
| "readme" | ||
| ], | ||
| "homepage": "https://github.com/consentdotio/readie", | ||
| "bugs": { | ||
| "url": "https://github.com/consentdotio/readie/issues" | ||
| }, | ||
| "license": "MIT", | ||
| "author": "Christopher Burns <burnedchris>", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/consentdotio/readie.git" | ||
| }, | ||
| "bin": { | ||
| "readie": "dist/index.js" | ||
| }, | ||
| "files": [ | ||
| "dist", | ||
| "schemas", | ||
| "README.md", | ||
| "LICENSE", | ||
| "CHANGELOG.md", | ||
| "CONTRIBUTING.md", | ||
| "CODE_OF_CONDUCT.md", | ||
| "SECURITY.md" | ||
| ], | ||
| "type": "module", | ||
| "main": "dist/index.js", | ||
| "imports": { | ||
| "#src/*": "./src/*" | ||
| }, | ||
| "scripts": { | ||
| "build": "bun build src/index.ts --outdir dist --target node --minify", | ||
| "changeset": "changeset", | ||
| "check": "ultracite check", | ||
| "clean": "bun --eval \"import { rmSync } from 'node:fs'; rmSync('dist', { recursive: true, force: true });\"", | ||
| "dev": "bun run src/index.ts", | ||
| "fix": "ultracite fix", | ||
| "prepare": "lefthook install", | ||
| "test": "bunx vitest run", | ||
| "test:watch": "bunx vitest", | ||
| "typecheck": "bunx tsc -p tsconfig.json --noEmit" | ||
| }, | ||
| "dependencies": { | ||
| "@effect/cli": "^0.73.2", | ||
| "@effect/platform": "^0.94.5", | ||
| "@effect/platform-node": "^0.104.1", | ||
| "@effect/printer": "^0.47.0", | ||
| "@effect/printer-ansi": "^0.47.0", | ||
| "effect": "^3.19.18" | ||
| }, | ||
| "devDependencies": { | ||
| "@changesets/changelog-github": "^0.5.2", | ||
| "@changesets/cli": "^2.29.8", | ||
| "@types/fs-extra": "^11.0.4", | ||
| "@types/node": "^25.3.0", | ||
| "changeset-conventional-commits": "^0.2.5", | ||
| "fs-extra": "^11.3.3", | ||
| "lefthook": "^2.1.1", | ||
| "oxfmt": "^0.34.0", | ||
| "oxlint": "^1.49.0", | ||
| "pathe": "^2.0.3", | ||
| "tempy": "^3.2.0", | ||
| "typescript": "^5.9.3", | ||
| "ultracite": "^7.2.3", | ||
| "vitest": "^4.0.18" | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a top‑level heading to satisfy MD041.
markdownlint requires a first‑line H1; this file starts with frontmatter only. Add an H1 after the frontmatter if the rule is enforced.
📝 Proposed fix
📝 Committable suggestion
🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: Ensure spelling is correct
Context: --- "readie": patch --- Added ultracte to readie
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.21.0)
[warning] 5-5: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents