-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Commit
…/customer-endpoints
- Loading branch information
There are no files selected for viewing
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
MONOREPO_ROOT_PATH=/Users/medusa/medusa |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# docblock-generator | ||
|
||
A CLI tool that can be used to generate TSDoc docblocks for TypeScript/JavaScript files under the `packages` directory of the main monorepo. | ||
|
||
## Prerequisites | ||
|
||
1. Run the `yarn` command to install dependencies. | ||
2. Copy the `.env.sample` to `.env` and change the `MONOREPO_ROOT_PATH` variable to the absolute path to the monorepo root. | ||
|
||
--- | ||
|
||
## Usage | ||
|
||
### Generate for a specific file | ||
|
||
Run the following command to run the tool for a specific file: | ||
|
||
```bash | ||
yarn start run /absolute/path/to/file.ts | ||
``` | ||
|
||
### Generate for git-changed files | ||
|
||
Run the following command to run the tool for applicable git file changes: | ||
|
||
```bash | ||
yarn start run:changes | ||
``` | ||
|
||
### Generate for a specific commit | ||
|
||
Run the following command to run the tool for a commit SHA hash: | ||
|
||
```bash | ||
yarn start run:commit <commit-sha> | ||
``` | ||
|
||
Where `<commit-sha>` is the SHA of the commit. For example, `e28fa7fbdf45c5b1fa19848db731132a0bf1757d`. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
{ | ||
"name": "docblock-generator", | ||
"license": "MIT", | ||
"scripts": { | ||
"start": "ts-node src/index.ts", | ||
"build": "tsc", | ||
"watch": "tsc --watch", | ||
"prepublishOnly": "cross-env NODE_ENV=production tsc --build" | ||
}, | ||
"publishConfig": { | ||
"access": "public" | ||
}, | ||
"version": "0.0.0", | ||
"type": "module", | ||
"exports": "./dist/index.js", | ||
"bin": { | ||
"workflow-diagrams-generator": "dist/index.js" | ||
}, | ||
"dependencies": { | ||
"@octokit/core": "^5.0.2", | ||
"commander": "^11.1.0", | ||
"dotenv": "^16.3.1", | ||
"eslint": "^8.56.0", | ||
"minimatch": "^9.0.3", | ||
"ts-node": "^10.9.1", | ||
"typescript": "5.2" | ||
}, | ||
"devDependencies": { | ||
"@types/node": "^20.9.4" | ||
} | ||
} |