npm - dev-playbooks - Versions diffs - 1.0.0 - Mend

dev-playbooks 1.0.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.

Files changed (142) hide show

package/skills/devbooks-code-review/references/pr-template-and-guidelines.md ADDED Viewed

@@ -0,0 +1,321 @@
+# Pull Request Template and Guidelines
+Inspired by VS Code’s `.github/pull_request_template.md`, this document defines a standard PR workflow.
+---
+## 1) PR template
+```markdown
+## Summary
+<!-- Describe what this PR does in 1–3 sentences -->
+## Related Issues
+<!-- Link issues using Fixes #123 or Relates to #456 -->
+## Changes
+<!-- List the key changes -->
+- [ ] Change 1
+- [ ] Change 2
+- [ ] Change 3
+## Type of Change
+<!-- Select one -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] Documentation update
+- [ ] Refactoring (no functional changes)
+## Test Plan
+<!-- Describe how to test this change -->
+1. Step 1
+2. Step 2
+3. Expected result
+## Checklist
+<!-- Confirm the following -->
+- [ ] Code follows project conventions
+- [ ] Relevant tests added/updated
+- [ ] All tests pass (`npm test`)
+- [ ] Relevant docs updated
+- [ ] Commit messages follow Conventional Commits
+- [ ] Self-reviewed; no debug statements left behind
+## Screenshots (if applicable)
+<!-- If this includes UI changes, attach screenshots -->
+```
+---
+## 2) PR types and size
+### Type definitions
+| Type | Prefix | Description |
+|------|--------|-------------|
+| Bug fix | `fix:` | Fixes issues in existing functionality |
+| Feature | `feat:` | Adds new functionality |
+| Refactor | `refactor:` | Code improvements without behavioral changes |
+| Docs | `docs:` | Documentation-only changes |
+| Test | `test:` | Adds or modifies tests |
+| Build | `build:` | Build system or dependency changes |
+| Performance | `perf:` | Performance optimizations |
+### Size guidance
+| Size | Lines changed | Review time | Recommendation |
+|------|--------------:|------------|----------------|
+| XS | < 50 | ~15 minutes | Quick merge |
+| S | 50–200 | ~30 minutes | Standard review |
+| M | 200–500 | ~1 hour | Careful review |
+| L | 500–1000 | 2+ hours | Consider splitting |
+| XL | > 1000 | half day+ | **Must split** |
+Principle: one PR does one thing; keep it atomic.
+---
+## 3) Commit conventions
+### Conventional Commits format
+```
+<type>(<scope>): <subject>
+<body>
+<footer>
+```
+### Examples
+```
+feat(auth): add OAuth2 login support
+- Add OAuth2 provider configuration
+- Implement token refresh mechanism
+- Add logout cleanup logic
+Closes #123
+```
+```
+fix(api): handle null response from external service
+The external API sometimes returns null instead of an empty array.
+Added defensive check to prevent runtime errors.
+Fixes #456
+```
+### Common types
+| Type | Meaning | Example |
+|------|---------|---------|
+| `feat` | Feature | `feat(user): add profile edit` |
+| `fix` | Bug fix | `fix(auth): correct token expiry` |
+| `docs` | Docs | `docs(readme): update install guide` |
+| `style` | Formatting | `style: fix indentation` |
+| `refactor` | Refactor | `refactor(api): extract common logic` |
+| `test` | Tests | `test(user): add unit tests` |
+| `chore` | Misc | `chore(deps): update lodash` |
+---
+## 4) Review checklist
+### Author self-check
+Before opening the PR, confirm:
+```bash
+# 1) Lint/type checks
+npm run lint
+npm run compile
+# 2) Tests
+npm test
+# 3) No debug code
+rg 'console\\.(log|debug)|debugger' src/ --type ts
+# 4) No accidental focused tests
+rg '\\.only\\s*\\(' tests/ --type ts
+# 5) No secrets
+rg '(password|secret|token|key)\\s*[:=]' --type ts -i
+```
+### Reviewer checklist
+When reviewing, focus on:
+**Correctness**
+- [ ] Does the code implement what the PR describes?
+- [ ] Are edge cases handled?
+- [ ] Are error cases handled?
+**Code quality**
+- [ ] Are names clear?
+- [ ] Are functions too long?
+- [ ] Is there duplicated code?
+- [ ] Any obvious performance issues?
+**Security**
+- [ ] SQL injection risk?
+- [ ] XSS risk?
+- [ ] Sensitive data protected?
+**Tests**
+- [ ] Are there relevant tests?
+- [ ] Do tests cover major paths?
+- [ ] Are tests isolated and repeatable?
+**Docs**
+- [ ] Public API documented?
+- [ ] README needs updates?
+- [ ] Changelog needs updates?
+---
+## 5) PR workflow
+### Standard flow
+```
+1. Create a branch
+   git checkout -b feat/feature-name
+2. Develop and commit
+   git add .
+   git commit -m "feat(scope): description"
+3. Push branch
+   git push -u origin feat/feature-name
+4. Open PR
+   - Fill the PR template
+   - Link issues
+   - Request review
+5. Address review feedback
+   - Reply to comments
+   - Push fixes
+   - Re-request review
+6. Merge
+   - Squash and merge (recommended)
+   - Delete source branch
+```
+### Branch naming
+| Type | Format | Example |
+|------|--------|---------|
+| Feature | `feat/<name>` | `feat/user-auth` |
+| Fix | `fix/<issue-id>` | `fix/123-login-error` |
+| Docs | `docs/<name>` | `docs/api-guide` |
+| Refactor | `refactor/<name>` | `refactor/auth-service` |
+| Hotfix | `hotfix/<name>` | `hotfix/security-patch` |
+---
+## 6) Review etiquette
+### Authors
+- Provide sufficient context
+- Respond to feedback promptly
+- Respect reviewers’ time
+- Avoid overly large PRs
+### Reviewers
+- Review in a timely manner (within 24–48 hours)
+- Provide constructive suggestions
+- Explain “why”, not only “what”
+- Differentiate “must fix” vs “nice to have”
+### Comment format
+```markdown
+# Must fix
+🔴 **Must**: there is a security issue here; add input validation.
+# Suggestion
+🟡 **Suggestion**: consider using `Array.from()` instead of spread.
+# Question
+🔵 **Question**: what is the rationale for this timeout value?
+# Praise
+🟢 **Praise**: nice abstraction!
+```
+---
+## 7) Automation checks
+### CI workflow example
+```yaml
+# .github/workflows/pr-check.yml
+name: PR Check
+on:
+  pull_request:
+    branches: [main, develop]
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+      - name: Install
+        run: npm ci
+      - name: Lint
+        run: npm run lint
+      - name: Type Check
+        run: npm run compile
+      - name: Test
+        run: npm test
+      - name: Check for debug statements
+        run: |
+          if rg 'console\\.(log|debug)|debugger' src/ --type ts; then
+            echo "::error::Found debug statements"
+            exit 1
+          fi
+```
+### Required checks
+| Check | Description |
+|-------|-------------|
+| Lint | ESLint rules pass |
+| TypeScript | Type check passes |
+| Tests | All tests pass |
+| Coverage | Coverage not below baseline |
+| Build | Build succeeds |

package/skills/devbooks-code-review/references/resource-management-review-checklist.md ADDED Viewed

@@ -0,0 +1,311 @@
+# Resource Management Review Checklist
+Inspired by VS Code’s `code-no-potentially-unsafe-disposables` and `code-must-use-super-dispose` rules.
+---
+## 1) Common resource leak patterns
+### Subscription / listener leaks
+```typescript
+// Bad: subscription is never removed
+class MyComponent {
+  private handler = (e: Event) => { /* ... */ };
+  initialize() {
+    document.addEventListener('click', this.handler);
+    // Missing removeEventListener
+  }
+}
+// Good: use AbortController
+class MyComponent {
+  private abortController = new AbortController();
+  initialize() {
+    document.addEventListener('click', this.handler, {
+      signal: this.abortController.signal
+    });
+  }
+  dispose() {
+    this.abortController.abort();
+  }
+}
+```
+### Timer leaks
+```typescript
+// Bad: timer is never cleared
+class Poller {
+  start() {
+    setInterval(() => this.poll(), 1000);
+    // Missing cleanup
+  }
+}
+// Good: keep the handle and clear it in dispose
+class Poller {
+  private intervalId?: NodeJS.Timeout;
+  start() {
+    this.intervalId = setInterval(() => this.poll(), 1000);
+  }
+  dispose() {
+    if (this.intervalId) {
+      clearInterval(this.intervalId);
+      this.intervalId = undefined;
+    }
+  }
+}
+```
+### Stream / connection leaks
+```typescript
+// Bad: stream is not closed on error
+async function readFile(path: string) {
+  const stream = fs.createReadStream(path);
+  const data = await streamToString(stream);
+  // If streamToString throws, the stream will remain open
+  return data;
+}
+// Good: use try/finally
+async function readFile(path: string) {
+  const stream = fs.createReadStream(path);
+  try {
+    return await streamToString(stream);
+  } finally {
+    stream.destroy();
+  }
+}
+// Better: use using (TypeScript 5.2+)
+async function readFile(path: string) {
+  using stream = fs.createReadStream(path);
+  return await streamToString(stream);
+}
+```
+---
+## 2) DisposableStore pattern
+### Basic usage
+```typescript
+import { Disposable, DisposableStore } from 'vs/base/common/lifecycle';
+class MyService extends Disposable {
+  // Must be readonly
+  private readonly _disposables = new DisposableStore();
+  constructor() {
+    super();
+    // Register subscription in the store
+    this._disposables.add(
+      eventEmitter.on('change', () => this.handleChange())
+    );
+    // Register timers/resources in the store
+    this._disposables.add(
+      new IntervalTimer(() => this.poll(), 1000)
+    );
+  }
+  override dispose() {
+    this._disposables.dispose();
+    super.dispose(); // Must call
+  }
+}
+```
+### Rules to check
+| Rule | Detection pattern | Severity |
+|------|-------------------|----------|
+| `DisposableStore` must be `readonly` | `private\\s+(?!readonly)\\s*_?\\w*[Dd]isposable` | Error |
+| `dispose()` must call `super.dispose()` | `override\\s+dispose\\(\\).*\\{(?![\\s\\S]*super\\.dispose)` | Error |
+| Subscriptions must be registered | `.on\\(.*\\)` without `.add(` | Warning |
+| Tests should check for leaks | missing `ensureNoDisposablesAreLeakedInTestSuite` | Warning |
+---
+## 3) Detecting leaks in tests
+### Using `ensureNoDisposablesAreLeakedInTestSuite`
+```typescript
+import { ensureNoDisposablesAreLeakedInTestSuite } from 'vs/base/test/common/utils';
+suite('MyService', () => {
+  // Enable leak detection at suite start
+  ensureNoDisposablesAreLeakedInTestSuite();
+  let service: MyService;
+  setup(() => {
+    service = new MyService();
+  });
+  teardown(() => {
+    service.dispose(); // Must clean up
+  });
+  test('should do something', () => {
+    // test code
+  });
+});
+```
+### Common test leak patterns
+```typescript
+// Bad: disposable created in a test is never disposed
+test('creates disposable', () => {
+  const disposable = new MyDisposable();
+  // test ends, disposable not disposed -> leak
+});
+// Good: dispose in teardown
+let disposable: MyDisposable;
+setup(() => {
+  disposable = new MyDisposable();
+});
+teardown(() => {
+  disposable.dispose();
+});
+```
+---
+## 4) Review checklist
+### Must check in code review
+- [ ] **`DisposableStore` declarations**
+  - Is it `readonly`?
+  - Is it `private`?
+- [ ] **`dispose()` method**
+  - Does it call `super.dispose()`?
+  - Does it clean up all known resources?
+  - Is cleanup defined in a base class when appropriate?
+- [ ] **Subscriptions / listeners**
+  - Are they registered in a `DisposableStore`?
+  - Is there a corresponding cancellation/removal path?
+  - Is `AbortController` used where applicable?
+- [ ] **Timers**
+  - Does `setInterval` have a corresponding `clearInterval`?
+  - Are `setTimeout` callbacks canceled on teardown/dispose?
+- [ ] **Streams / connections**
+  - Are they closed in a `finally` block?
+  - Is `using` used when available?
+- [ ] **Tests**
+  - Is `ensureNoDisposablesAreLeakedInTestSuite()` present?
+  - Does teardown dispose everything created by tests?
+---
+## 5) Automated detection
+### ESLint rule config
+```javascript
+// eslint.config.js
+module.exports = {
+  rules: {
+    // Custom rule: DisposableStore must be readonly
+    'local/code-no-potentially-unsafe-disposables': 'error',
+    // Custom rule: dispose must call super
+    'local/code-must-use-super-dispose': 'error',
+  }
+};
+```
+### Grep / ripgrep commands
+```bash
+# Detect non-readonly DisposableStore fields
+rg 'private\\s+(?!readonly)\\s*_?\\w*[Dd]isposable' --type ts
+# Detect dispose() methods missing super.dispose()
+rg -U 'override\\s+dispose\\(\\).*?\\{[^}]*\\}' --type ts | grep -v 'super.dispose'
+# Detect setInterval without clearInterval
+rg 'setInterval\\(' --type ts -l | xargs -I {} sh -c 'rg -c "clearInterval" {} || echo "Missing clearInterval: {}"'
+```
+---
+## 6) Fix guide
+### Add a `DisposableStore`
+```typescript
+// Before
+class MyClass {
+  private subscription: Subscription;
+  constructor() {
+    this.subscription = eventEmitter.on('change', () => {});
+  }
+}
+// After
+class MyClass extends Disposable {
+  private readonly _disposables = new DisposableStore();
+  constructor() {
+    super();
+    this._disposables.add(
+      eventEmitter.on('change', () => {})
+    );
+  }
+  override dispose() {
+    this._disposables.dispose();
+    super.dispose();
+  }
+}
+```
+### Add test leak detection
+```typescript
+// Before
+suite('MyTest', () => {
+  test('does something', () => {
+    const obj = new MyDisposable();
+    // Not disposed
+  });
+});
+// After
+suite('MyTest', () => {
+  ensureNoDisposablesAreLeakedInTestSuite();
+  const disposables = new DisposableStore();
+  teardown(() => {
+    disposables.clear();
+  });
+  test('does something', () => {
+    const obj = disposables.add(new MyDisposable());
+    // Automatically disposed in teardown
+  });
+});
+```