Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/neat-rabbits-clap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"readie": patch
---

Added ultracte to readie
Comment on lines +1 to +5
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

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
---
 "readie": patch
---
 
-Added ultracite to readie
+# Changes
+
+Added ultracite to readie
📝 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.

Suggested change
---
"readie": patch
---
Added ultracte to readie
---
"readie": patch
---
# Changes
Added ultracite to readie
🧰 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
Verify each finding against the current code and only fix it if needed.

In @.changeset/neat-rabbits-clap.md around lines 1 - 5, This changeset file has
only YAML frontmatter and no H1, triggering markdownlint rule MD041; open
.changeset/neat-rabbits-clap.md and add a top‑level heading line (e.g., "#
Changes" or "# neat-rabbits-clap") immediately after the frontmatter closing ---
so the file contains frontmatter followed by an H1 and then the existing body
("Added ultracte to readie").

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

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

‼️ 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.

Suggested change
Added ultracte to readie
Added ultracite to readie
🧰 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
Verify each finding against the current code and only fix it if needed.

In @.changeset/neat-rabbits-clap.md at line 5, In the changeset entry in
.changeset/neat-rabbits-clap.md replace the misspelled token "ultracte" with the
correct spelling "ultracite" so the sentence reads "Added ultracite to readie";
update only that word in the changeset content.

2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
uses: actions/setup-node@v4
with:
node-version: 22
registry-url: 'https://registry.npmjs.org'
registry-url: "https://registry.npmjs.org"

- name: Install dependencies
run: bun install --frozen-lockfile
Expand Down
23 changes: 23 additions & 0 deletions .oxfmtrc.jsonc
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",
},
}
4 changes: 4 additions & 0 deletions .oxlintrc.json
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"]
}
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ You can also run it without global install via `npx readie`.

```json
{
"banner": "<h1 align=\"center\">{{title}}</h1>",
"footer": "https://example.com?ref={{packageNameEncoded}}"
"banner": "<h1 align=\"center\">{{title}}</h1>",
"footer": "https://example.com?ref={{packageNameEncoded}}"
}
```

Expand Down
308 changes: 257 additions & 51 deletions bun.lock

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions examples/basic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ npm install acme-toolkit
1. Import the toolkit and initialize your client.

```ts
import { createClient } from 'acme-toolkit'
import { createClient } from "acme-toolkit";

const client = createClient()
const client = createClient();
```

## Support
Expand Down
46 changes: 19 additions & 27 deletions examples/basic/readie.json
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."]
}
14 changes: 7 additions & 7 deletions examples/c15t/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,15 @@ To manually install, follow the guide in our [docs – manual setup](https://c15

```tsx
// App.tsx
import { ConsentManagerProvider, CookieBanner } from '@c15t/react'
import { ConsentManagerProvider, CookieBanner } from "@c15t/react";

function App() {
return (
<ConsentManagerProvider>
<YourApp />
<CookieBanner />
</ConsentManagerProvider>
)
return (
<ConsentManagerProvider>
<YourApp />
<CookieBanner />
</ConsentManagerProvider>
);
}
```

Expand Down
14 changes: 7 additions & 7 deletions examples/c15t/old.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,15 @@ To manually install, follow the guide in our [docs – manual setup](https://c15

```tsx
// App.tsx
import { ConsentManagerProvider, CookieBanner } from '@c15t/react'
import { ConsentManagerProvider, CookieBanner } from "@c15t/react";

function App() {
return (
<ConsentManagerProvider>
<YourApp />
<CookieBanner />
</ConsentManagerProvider>
)
return (
<ConsentManagerProvider>
<YourApp />
<CookieBanner />
</ConsentManagerProvider>
);
}
```

Expand Down
12 changes: 12 additions & 0 deletions lefthook.yml
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
136 changes: 74 additions & 62 deletions package.json
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"
}
}
Loading