Skip to content
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

[Documentation] Create Development Scripts Guide #35

Open
12mv2 opened this issue Nov 30, 2024 · 0 comments
Open

[Documentation] Create Development Scripts Guide #35

12mv2 opened this issue Nov 30, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@12mv2
Copy link
Collaborator

12mv2 commented Nov 30, 2024

## Description
Create a detailed guide explaining all npm scripts available in the project, their purposes, and when to use them during development.

### Task Requirements
1. Document each script in package.json
2. Explain when and why to use each script
3. Provide example use cases
4. Include common troubleshooting tips

### Scripts to Document
```json
{
  "build": "npm run compile && webpack --config webpack.config.js",
  "build:prod": "npm run compile && webpack --config webpack.prod.js",
  "compile": "tsc -p ./tsconfig.json",
  "webpack": "webpack",
  "watch": "concurrently \"webpack --watch\" \"tsc -watch -p ./tsconfig.json\"",
  "lint": "eslint src",
  "pretest": "npm run compile",
  "test": "node ./out/test/runTest.js",
  "test:parser-performance": "TEST_SUITE=parser-performance npm run test",
  "package": "vsce package"
}
@12mv2 12mv2 added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Nov 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant