@aramassa/ai-rules 0.8.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/artifact/agents/agent-creation.agent.md +2 -2
- package/artifact/agents/technical-writer.agent.md +75 -0
- package/artifact/instructions/package-management.md +29 -0
- package/artifact/instructions/rules/development/cli-design.md +286 -0
- package/artifact/instructions/rules/development/npm-package-rollup-build.md +883 -0
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +136 -18
- package/package.json +2 -1
- package/presets/README.md +268 -14
- package/presets/agents.yaml +15 -1
- package/presets/basic.yaml +37 -0
- package/presets/github-workflow.yaml +36 -0
- package/presets/monorepo/typescript.yaml +12 -0
- package/presets/openai.yaml +17 -0
- package/presets/python.yaml +25 -0
- package/presets/test-best-practices.yaml +46 -0
- package/presets/typescript.yaml +27 -0
|
@@ -25,3 +25,15 @@ recipe:
|
|
|
25
25
|
type: package-management
|
|
26
26
|
category: workspace
|
|
27
27
|
language: typescript
|
|
28
|
+
- title: TypeScript Rollup Build Rules
|
|
29
|
+
mode: append
|
|
30
|
+
frontmatter:
|
|
31
|
+
description: |
|
|
32
|
+
Rules for building TypeScript projects with Rollup.
|
|
33
|
+
This includes configuration, plugins, and build workflows.
|
|
34
|
+
applyTo: "**/rollup.config.mjs"
|
|
35
|
+
out: typescript-workspace.instructions.md
|
|
36
|
+
type: development
|
|
37
|
+
language: typescript
|
|
38
|
+
filters:
|
|
39
|
+
framework: rollup
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
description: OpenAI API を使用するプロジェクト向けの instruction 構成です。
|
|
2
|
+
|
|
3
|
+
config:
|
|
4
|
+
baseDir: .github/instructions
|
|
5
|
+
|
|
6
|
+
recipe:
|
|
7
|
+
- import: :typescript
|
|
8
|
+
- title: OpenAI API Usage Guidelines
|
|
9
|
+
frontmatter:
|
|
10
|
+
description: |
|
|
11
|
+
Guidelines for using OpenAI API effectively in your projects.
|
|
12
|
+
Covers API usage patterns, error handling, and best practices.
|
|
13
|
+
applyTo: "**/*.{ts,js}"
|
|
14
|
+
out: openai.instructions.md
|
|
15
|
+
type: coding-rules
|
|
16
|
+
category: api-usage
|
|
17
|
+
focus: openai
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
description: Python プロジェクト向けの標準的な instruction 構成です。
|
|
2
|
+
|
|
3
|
+
recipe:
|
|
4
|
+
- import: :basic
|
|
5
|
+
- import: :docs-ai
|
|
6
|
+
- title: Python CLI Implementation Guidelines
|
|
7
|
+
frontmatter:
|
|
8
|
+
description: |
|
|
9
|
+
Comprehensive guidelines for Python CLI application development.
|
|
10
|
+
Covers library selection, architecture design, and implementation patterns.
|
|
11
|
+
applyTo: "**/*.py"
|
|
12
|
+
out: ./.github/instructions/python.instructions.md
|
|
13
|
+
type: python-cli
|
|
14
|
+
category: implementation
|
|
15
|
+
language: python
|
|
16
|
+
- title: Python Workspace Management
|
|
17
|
+
frontmatter:
|
|
18
|
+
description: |
|
|
19
|
+
Rules for managing Python workspaces using uv.
|
|
20
|
+
applyTo: "**/*.py"
|
|
21
|
+
mode: append
|
|
22
|
+
out: ./.github/instructions/python.instructions.md
|
|
23
|
+
type: workspace-management
|
|
24
|
+
category: best-practices
|
|
25
|
+
language: python
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
description: プロジェクト横断的なテストのベストプラクティスと E2E テストガイドラインです。
|
|
2
|
+
|
|
3
|
+
config:
|
|
4
|
+
baseDir: .github/instructions
|
|
5
|
+
|
|
6
|
+
recipe:
|
|
7
|
+
- title: E2E Test BDD Guidelines
|
|
8
|
+
frontmatter:
|
|
9
|
+
description: |
|
|
10
|
+
Guidelines for writing E2E tests using BDD approach.
|
|
11
|
+
applyTo: "e2e/**/*"
|
|
12
|
+
out: test-best-practices.instructions.md
|
|
13
|
+
type: test
|
|
14
|
+
- title: E2E CLI Execution Testing
|
|
15
|
+
frontmatter:
|
|
16
|
+
description: |
|
|
17
|
+
Guidelines for E2E testing of CLI applications.
|
|
18
|
+
Covers command-line based testing approaches and documentation.
|
|
19
|
+
applyTo: "docs-ai/e2e-test/**/*"
|
|
20
|
+
mode: append
|
|
21
|
+
out: test-best-practices.instructions.md
|
|
22
|
+
type: test
|
|
23
|
+
category: e2e-test
|
|
24
|
+
focus: cli-execution
|
|
25
|
+
- title: Environment Independent Path Testing
|
|
26
|
+
frontmatter:
|
|
27
|
+
description: |
|
|
28
|
+
Best practices for writing tests that work across different environments.
|
|
29
|
+
Covers path handling, temporary directories, and environment setup.
|
|
30
|
+
applyTo: "test/**/*.{ts,js}"
|
|
31
|
+
mode: append
|
|
32
|
+
out: test-best-practices.instructions.md
|
|
33
|
+
type: test
|
|
34
|
+
category: best-practices
|
|
35
|
+
focus: environment-independence
|
|
36
|
+
- title: GitHub Actions Testing Policy
|
|
37
|
+
frontmatter:
|
|
38
|
+
description: |
|
|
39
|
+
Policy for testing GitHub Actions workflows.
|
|
40
|
+
Explains why workflow files should not have dedicated test files.
|
|
41
|
+
applyTo: ".github/workflows/*.{yml,yaml}"
|
|
42
|
+
mode: append
|
|
43
|
+
out: test-best-practices.instructions.md
|
|
44
|
+
type: test
|
|
45
|
+
category: github-actions
|
|
46
|
+
focus: test-policy
|
package/presets/typescript.yaml
CHANGED
|
@@ -11,8 +11,35 @@ recipe:
|
|
|
11
11
|
out: ./.github/instructions/typescript.instructions.md
|
|
12
12
|
type: coding-rules
|
|
13
13
|
language: typescript
|
|
14
|
+
- title: Node.js Coding Rules
|
|
15
|
+
frontmatter:
|
|
16
|
+
description: |
|
|
17
|
+
These rules are for writing Node.js code in the project.
|
|
18
|
+
applyTo: "**/*.{js,ts}"
|
|
19
|
+
mode: append
|
|
20
|
+
out: ./.github/instructions/typescript.instructions.md
|
|
21
|
+
type: coding-rules
|
|
22
|
+
language: nodejs
|
|
14
23
|
- title: TypeScript / Vitest
|
|
15
24
|
mode: append
|
|
16
25
|
out: ./.github/instructions/typescript.instructions.md
|
|
17
26
|
type: test
|
|
18
27
|
language: typescript
|
|
28
|
+
- title: Node.js Test Restrictions
|
|
29
|
+
mode: append
|
|
30
|
+
out: ./.github/instructions/typescript.instructions.md
|
|
31
|
+
type: test
|
|
32
|
+
category: restrictions
|
|
33
|
+
language: typescript
|
|
34
|
+
- title: Test Timeout Configuration
|
|
35
|
+
mode: append
|
|
36
|
+
out: ./.github/instructions/typescript.instructions.md
|
|
37
|
+
type: test
|
|
38
|
+
category: configuration
|
|
39
|
+
focus: timeout
|
|
40
|
+
- title: Code Quality Tools
|
|
41
|
+
mode: append
|
|
42
|
+
out: ./.github/instructions/typescript.instructions.md
|
|
43
|
+
type: development-rules,best-practices
|
|
44
|
+
category: code-quality
|
|
45
|
+
language: typescript
|