agentleFS
johnpapajohnpapa/vscode-peacock/.github/copilot-instructions.md

vscode-peacock

Copilot instructions1.2k starsChanged 2 months agoMITView on GitHub

VS Code extension written in TypeScript, bundled with Webpack, published to the VS Code Marketplace.

  • Reads credentials

Trending

More talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 2 mentionsApr 2026: 0 mentionsMay 2026: 1 mentionJun 2026: 0 mentionsJul 2026: 0 mentionsAug 2026: 1 mentionSep 2026: 1 mentionOct 2026: 1 mentionNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the johnpapa/vscode-peacock repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about johnpapa/vscode-peacock

The biggest 5 of 18 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 18

Talked about on GitHub, Hacker News, Bluesky and Stack Overflow (18 times).

On GitHub · 15

10 more on GitHub

On Hacker News · 1

The file

We split this copilot-instructions.md into the rules it gives an agent

12 rules. About 0 are common, 2 are distinctive, and 10 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 10

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use explicit types for function parameters and return values

    line 10
  2. Very specific:

    Use import type for type-only imports

    line 11
  3. Very specific:

    All source code lives in src/

    line 12
  4. Very specific:

    Use vscode.commands.registerCommand() for command registration

    line 16
  5. Very specific:

    Use vscode.workspace.getConfiguration('peacock') for reading settings

    line 17
  6. Very specific:

    Use vscode.window.showQuickPick() and vscode.window.showInputBox() for user input

    line 18
  7. Very specific:

    All commands must be declared in package.json under contributes.commands

    line 19
  8. Very specific:

    All settings must be declared in package.json under contributes.configuration.properties

    line 20
  9. Very specific:

    All color manipulation uses tinycolor2 via the helpers in src/color-library.ts

    line 24
  10. Distinctive:

    Never manipulate hex strings directly — always go through the color library

    line 25
  11. Very specific:

    Run unit tests: npm test

    line 32
  12. Very specific:

    Run e2e tests: npm run test:e2e

    line 33

≈ “Common” is an estimate: at least 1 in 5 of the 3,827 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md

Copilot Instructions — Peacock

Project Type

VS Code extension written in TypeScript, bundled with Webpack, published to the VS Code Marketplace.

TypeScript Conventions

  • Strict mode enabled (tsconfig.json)
  • Use explicit types for function parameters and return values
  • Use import type for type-only imports
  • All source code lives in src/

VS Code Extension Patterns

  • Use vscode.commands.registerCommand() for command registration
  • Use vscode.workspace.getConfiguration('peacock') for reading settings
  • Use vscode.window.showQuickPick() and vscode.window.showInputBox() for user input
  • All commands must be declared in package.json under contributes.commands
  • All settings must be declared in package.json under contributes.configuration.properties

Color Handling

  • All color manipulation uses tinycolor2 via the helpers in src/color-library.ts
  • Never manipulate hex strings directly — always go through the color library
  • Colors are stored as hex strings (e.g., #ff0000) in VS Code configuration

Test Conventions

  • Unit tests: Mocha + Sinon, located in src/test/
  • E2E tests: Playwright, located in e2e/ (primarily for docs screenshots)
  • Run unit tests: npm test
  • Run e2e tests: npm run test:e2e
  • Tests use testworkspace/ as the VS Code workspace
  • Every bug fix must include a regression test that fails without the fix and passes with it
  • Every new feature must include unit tests covering the happy path and relevant edge cases
  • Don't accept "this can't be tested" claims at face value. Grep src/test/ for the exact vscode API/state the change depends on — if any existing suite already stubs it (host lane can sinon.stub(vscode.env, ...)), reuse that lane/pattern instead of skipping the test. See PR #757 for a worked example.

Code Style

  • ESLint + Prettier (config in .eslintrc and .prettierrc.js)
  • Husky pre-commit hook runs Prettier automatically
  • Lint: npm run lint
  • Fix: npm run lint-fix

Maintenance Matrix

When this changes...Also update...
New command addedpackage.json (contributes.commands + menus), src/models/enums.ts (Commands enum), src/commands.ts, src/extension.ts (register), src/test/, docs/guide/, docs/changelog/README.md
New StandardSettings setting addedpackage.json (contributes.configuration), src/models/enums.ts (StandardSettings enum), src/configuration/read-configuration.ts (add reader), src/test/, docs/guide/, docs/changelog/README.md
New AffectedSettings setting addedpackage.json (contributes.configuration), src/models/enums.ts (AffectedSettings + ColorSettings enums), src/models/interfaces.ts (IPeacockAffectedElementSettings), src/configuration/read-configuration.ts (getAffectedElements + collect* function), src/configuration/update-configuration.ts (updateAffectedElements), src/test/suite/affected-elements.test.ts, docs/guide/, docs/changelog/README.md
Bug fixsrc/test/ (add a regression test that fails without the fix), docs/changelog/README.md
Color application logicsrc/apply-color.ts, src/color-library.ts, related unit tests
Live Share integrationsrc/live-share/, src/live-share/liveshare-commands.ts, package.json (vsls dependency), related tests, run npm run test-all
Remote featuressrc/remote/, related tests
Docs contentdocs/ (update pages), docs/_sidebar.md (if new page), e2e/ (if screenshots change)
Dependencies updatedpackage.json, package-lock.json, verify webpack build, run full test suite
Version bumppackage.json (version field only), docs/changelog/README.md

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.