docs: lint to awesome-lint 2.0 standards#1624
Conversation
WalkthroughBroad editorial normalization of Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
package.json (3)
2-2: Rename looks good; ensure npm publish is disabled.If this repo isn't meant to be published, add
"private": trueto prevent accidental publishes.Apply outside the shown hunk:
{ "name": "awesome-angular", + "private": true, "version": "0.0.0",
10-15: Tidy keywords (optional).Consider removing legacy "angular 2"/"awesome angular 2" terms unless they’re intentionally retained for search.
18-18: Nit: use git+https URL form.Some tooling prefers
git+https://.... Current https URL also works; change only if you want maximal npm tooling compatibility.- "url": "https://github.com/PatrickJS/awesome-angular.git" + "url": "git+https://github.com/PatrickJS/awesome-angular.git"README.md (4)
226-226: Unify “Official web page/website” phrasing.For consistency, prefer a single phrase (e.g., “Official website”) across sections.
- * [Official web page](https://angular.dev/update-guide) ... + * [Official website](https://angular.dev/update-guide) ...Apply similarly at Lines 599 and 627. I can bulk-edit if you’d like.
Also applies to: 599-599, 627-631
792-792: Capitalize brand in item title.Use “Transifex” (brand) in the list item title for consistency with Awesome guidelines (“Use the project’s name”).
-* [transifex](https://github.com/transifex/transifex-javascript/tree/master/packages/angular/projects/tx-native-angular-sdk) - You can easily localize Angular components using the [transifex](https://www.npmjs.com/package/@transifex/angular) library extension. This library extends the functionality of [Transifex Native JavaScript SDK](https://developers.transifex.com/docs/javascript-sdk). +* [Transifex](https://github.com/transifex/transifex-javascript/tree/master/packages/angular/projects/tx-native-angular-sdk) - You can easily localize Angular components using the [@transifex/angular](https://www.npmjs.com/package/@transifex/angular) library extension. This library extends the functionality of the [Transifex Native JavaScript SDK](https://developers.transifex.com/docs/javascript-sdk).
1700-1700: Avoid “Windows” ambiguity.“multi-modal Windows” can be read as Microsoft Windows. Consider “multi‑modal windows” (lowercase) or “multi‑window modals.”
-* [ngx-whats-new](https://github.com/4gray/ngx-whats-new) - A simple library for creating multi-modal Windows. +* [ngx-whats-new](https://github.com/4gray/ngx-whats-new) - A simple library for creating multi‑modal windows.
2177-2179: Minor title-casing nit.Consider “Angular Enterprise” (proper noun) to match site branding.
-* [Angular enterprise](https://angular-enterprise.com/en/ngcategory/resources/) +* [Angular Enterprise](https://angular-enterprise.com/en/ngcategory/resources/)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(44 hunks)package.json(1 hunks)
🔇 Additional comments (8)
package.json (2)
5-5: Main entry casing fix LGTM.
25-25: Verify anchor exists — OKREADME.md contains "## Contents" (line 17) — the "#contents" anchor is valid; no change required. Running
npx -y awesome-lint@^2 README.mdreturned a lint error: "Awesome list must reside in a valid git repository" (unrelated to the anchor); verify repo/lint environment separately.README.md (6)
151-156: Builder naming normalization LGTM.esbuild/custom-esbuild casing matches upstream naming.
200-200: Deployment entry casing LGTM.“AWS Amplify” capitalization is correct.
251-257: Community section naming/casing updates LGTM.
262-269: Newsletter names standardized LGTM.
683-706: Developer Tools additions LGTM (mix of OSS/paid annotated clearly).No lint blockers spotted.
1-1: Run awesome-lint v2 locally and fix README issues.Sandbox lint failed: "Awesome list must reside in a valid git repository" (remark-lint:awesome-github). Run locally: npx -y awesome-lint@^2 README.md
- Many list entries lack trailing periods — examples (lines): 254, 358, 360, 418, 449, 463, 536, 654, 1032, 1124, 1186, 1303, 1437, 1476, 1574, 1844, 1847, 1892, 1897, 1980.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
package.json (3)
6-6: Remove unused "main".This is a docs/list repo with private: true; "main" is unused and can confuse tooling.
- "main": "README.md",
19-23: Use a valid SPDX identifier for the license."CC0" is non-standard; npm expects "CC0-1.0".
- "license": "CC0", + "license": "CC0-1.0",
24-24: Prefer stable homepage anchor."#readme" is a stable GitHub anchor; "#contents" can break if the heading changes.
- "homepage": "https://github.com/PatrickJS/awesome-angular#contents" + "homepage": "https://github.com/PatrickJS/awesome-angular#readme"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(48 hunks)package.json(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- README.md
🔇 Additional comments (3)
package.json (3)
2-3: Good rename and publish-safety.Renaming to awesome-angular and setting private: true prevents accidental npm publish. LGTM.
11-14: Keywords look good.Concise and relevant for discoverability.
17-19: Repository and author metadata are correct.Standard npm style git+https URL is fine.
package.json
Outdated
| "version": "0.0.0", | ||
| "description": "A curated list of awesome Angular 2 resources", | ||
| "main": "readme.md", | ||
| "description": "A curated list of Awesome Angular resources", |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Ensure GitHub repo description matches this exactly (awesome-lint rule).
awesome-lint checks the repository’s GitHub description, not package.json. Verify the repo description is “A curated list of Awesome Angular resources”.
Run to confirm:
🏁 Script executed:
#!/bin/bash
curl -s https://api.github.com/repos/PatrickJS/awesome-angular | jq -r .descriptionLength of output: 60
Update GitHub repository description to exactly "A curated list of Awesome Angular resources"
Current description is ":page_facing_up: A curated list of awesome Angular resources" — remove the emoji and capitalize "Awesome" so it matches exactly.
🤖 Prompt for AI Agents
In package.json around line 5, the repository description currently includes an
emoji and incorrect capitalization; update the "description" value to exactly "A
curated list of Awesome Angular resources" (remove the leading emoji and change
"awesome" to "Awesome") and save the file ensuring the string matches the
requested text precisely.
1 participant
Summary by CodeRabbit
Documentation
Chores