Perform repo housekeeping #95
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tuliren
commented
Dec 25, 2022
| "directories": { | ||
| "lib": "src", | ||
| "test": "__tests__" | ||
| }, |
There was a problem hiding this comment.
directories is for information only.
tuliren
commented
Dec 25, 2022
| "files": [ | ||
| "dist/**/*", | ||
| "public/**/*" | ||
| ], |
There was a problem hiding this comment.
This field configures what files are included in the final package.
tuliren
commented
Dec 25, 2022
| @@ -2,17 +2,25 @@ | |||
| "name": "stoat", | |||
| "version": "0.0.8", | |||
| "description": "Stoat CLI", | |||
| "main": "src/index.ts", | |||
| "main": "dist/index.js", | |||
There was a problem hiding this comment.
The src/index.ts file will be included in the final package if it is the main. However, a ts file is not usable in the package. So I think technically the correct main is dist/index.js.
tuliren
commented
Dec 25, 2022
| "lint": "eslint src/**/*.ts", | ||
| "create": "npm run build && npm run test", | ||
| "build": "ncc build --source-map --license licenses.txt", | ||
| "build": "ncc build src/index.ts --source-map --license licenses.txt", |
There was a problem hiding this comment.
Because the main is a file in the dist, which does not exist before the build is run, we need to manually feed in the actual main file to build.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
I will merge this now, since I am working on a new plugin that depends on this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
cliclipackage currently includes all the files in theclidirectory, like tests and configurations, which are unnecessary. This PR updates thecli/package.jsonfile to package only the necessary files. I have checked locally that everything works. Please double check that the output is correct during the review or the next release.cli/.prettierignorefile is misnamed. It has been fixed.actionactionpackage is moved to the root directory during the refactoring. So Prettier no longer works for theactionpackage. This PR moves the files back.pluginRunner.