-
Notifications
You must be signed in to change notification settings - Fork 0
chore: implement linting and formatting compliance #5
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
db1b6f3
e863477
4ee1196
f950d28
300e4bd
488b2aa
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 |
|---|---|---|
| @@ -1,15 +1,19 @@ | ||
| ## Summary | ||
|
|
||
| Describe the change and why it is needed. | ||
|
|
||
| ## Changes | ||
| - | ||
|
|
||
| - <describe change> | ||
|
|
||
| ## Testing | ||
| - [ ] npm run lint | ||
|
|
||
| - [ ] npm run check | ||
| - [ ] npm test | ||
| - [ ] npm pack --dry-run (if publishing-related) | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] README.md updated or not needed (explain why) | ||
| - [ ] No generated artifacts committed | ||
| - [ ] Changes are scoped to the affected repository only | ||
| - [ ] Changes are scoped to the affected repository only |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| dist/ | ||
| node_modules/ | ||
| AGENTS.md | ||
| package-lock.json |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "semi": true, | ||
| "singleQuote": true, | ||
| "trailingComma": "all", | ||
| "printWidth": 100, | ||
| "tabWidth": 2 | ||
| } |
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,25 @@ | ||
| # Code of Conduct | ||
|
|
||
| ## Our pledge | ||
|
|
||
| We are committed to providing a friendly, safe, and welcoming environment for everyone. | ||
|
|
||
| ## Expected behavior | ||
|
|
||
| - Be respectful and considerate. | ||
| - Assume good intent and collaborate constructively. | ||
| - Provide and accept feedback gracefully. | ||
|
|
||
| ## Unacceptable behavior | ||
|
|
||
| - Harassment, discrimination, or hateful conduct. | ||
| - Personal attacks, trolling, or intimidation. | ||
| - Publishing private information without permission. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Maintainers may remove, edit, or reject contributions that violate this Code of Conduct. | ||
|
|
||
| ## Reporting | ||
| Report issues to the maintainers via GitHub Security Advisories or a private channel when possible. | ||
|
|
||
| Report issues to the maintainers via GitHub Security Advisories or a private channel when possible. |
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -74,6 +74,7 @@ compose-agentsmd apply-rules | |||||||||||
|
|
||||||||||||
| Ruleset files accept JSON with `//` or `/* */` comments. | ||||||||||||
|
|
||||||||||||
| <!-- prettier-ignore --> | ||||||||||||
| ```jsonc | ||||||||||||
| { | ||||||||||||
| // Rules source. Use github:owner/repo@ref or a local path. | ||||||||||||
|
|
@@ -131,14 +132,16 @@ Remote sources are cached under `~/.agentsmd/cache/<owner>/<repo>/<ref>/`. Use ` | |||||||||||
|
|
||||||||||||
| ```sh | ||||||||||||
| npm install | ||||||||||||
| npm run lint | ||||||||||||
| npm run build | ||||||||||||
| npm run check | ||||||||||||
| npm run format | ||||||||||||
| npm run typecheck | ||||||||||||
|
Comment on lines
+135
to
+137
|
||||||||||||
| npm run check | |
| npm run format | |
| npm run typecheck | |
| npm run format | |
| npm run check |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,18 @@ | ||
| # Security Policy | ||
|
|
||
| ## Supported versions | ||
|
|
||
| The latest published version is supported. | ||
|
|
||
| ## Reporting a vulnerability | ||
|
|
||
| Please report vulnerabilities privately via GitHub Security Advisories or by opening a private report to the maintainers. Do not file public issues for security-sensitive reports. | ||
|
|
||
| When reporting, include: | ||
|
|
||
| - A clear description of the vulnerability | ||
| - Steps to reproduce or a proof of concept | ||
| - Impact assessment | ||
| - Suggested mitigations (if known) | ||
|
|
||
| We will acknowledge receipt and work on a fix as quickly as possible. | ||
| We will acknowledge receipt and work on a fix as quickly as possible. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # Local operations rules | ||
|
|
||
| - After any change that requires a process or task restart to take effect, restart the affected local components before concluding. | ||
| - Verify post-restart state and report which components were restarted and their final status. | ||
| - For agent-runner behavior changes, identify the responsible runtime component (Scheduled Task `AgentRunner` / `dist/cli.js run`, webhook, UI) and restart the correct one(s) before concluding. | ||
| - Do not claim a restart occurred unless verified by deterministic evidence (new PID, port check, and/or the latest task-run log showing the expected new behavior). |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Distribution and release | ||
|
|
||
| - After publishing this repository, update the globally installed CLI to the latest version. | ||
| - After publishing this repository, update the globally installed CLI to the latest version. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,10 @@ | ||
| { | ||
| { | ||
| "source": "github:metyatech/agent-rules", | ||
| "domains": [ | ||
| "cli", | ||
| "node", | ||
| "release" | ||
| ], | ||
| "domains": ["cli", "node", "release"], | ||
| "extra": [ | ||
| "agent-rules-local/compose-agentsmd-local.md" | ||
| "agent-rules-local/compose-agentsmd-local.md", | ||
| "agent-rules-local/release.md", | ||
| "agent-rules-local/operations.md" | ||
| ], | ||
| "output": "AGENTS.md" | ||
| } |
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,36 @@ | ||||||||||||||||||||||
| import eslint from '@eslint/js'; | ||||||||||||||||||||||
| import tseslint from 'typescript-eslint'; | ||||||||||||||||||||||
| import prettier from 'eslint-config-prettier'; | ||||||||||||||||||||||
| import globals from 'globals'; | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| export default tseslint.config( | ||||||||||||||||||||||
| eslint.configs.recommended, | ||||||||||||||||||||||
| ...tseslint.configs.recommended, | ||||||||||||||||||||||
| prettier, | ||||||||||||||||||||||
| { | ||||||||||||||||||||||
| languageOptions: { | ||||||||||||||||||||||
| globals: { | ||||||||||||||||||||||
| ...globals.node, | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| { | ||||||||||||||||||||||
| files: ['src/**/*.ts'], | ||||||||||||||||||||||
| languageOptions: { | ||||||||||||||||||||||
| parserOptions: { | ||||||||||||||||||||||
| project: './tsconfig.json', | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| { | ||||||||||||||||||||||
|
||||||||||||||||||||||
| { | |
| { | |
| files: ['test/**/*.js'], | |
| languageOptions: { | |
| globals: { | |
| ...globals.node, | |
| }, | |
| }, | |
| }, | |
| { |
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.
The contributor setup still instructs running only
npm run lint+npm test, but this PR introducestypecheck/formatand CI now runsnpm run check. Consider updating this section to point contributors atnpm run check(or list the additional commands) so local verification matches CI.