-
-
Notifications
You must be signed in to change notification settings - Fork 1
feat(package): add node-plop and related dependencies #228
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d61ac1f
feat(package): add node-plop and related dependencies
stephansama 742412e
feat(cli): add name to package and cli logs
stephansama 71c4921
docs(env): remove readme template for env generator
stephansama f5e0377
chore(cli): add error handling to cli entrypoint
stephansama 7dfbac4
feat(cli): set default version to 0.0.0
stephansama df0095a
chore(prettier): add pnpm-workspace.yaml config to overrides
stephansama File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,27 @@ | ||
| import type { PlopTypes } from "@turbo/gen"; | ||
|
|
||
| import { actions, prompts } from "./utils"; | ||
|
|
||
| /* eslint-disable perfectionist/sort-objects */ | ||
| export default function generator(plop: PlopTypes.NodePlopAPI) { | ||
| plop.setGenerator("package", { | ||
| description: "Generate a new package", | ||
| prompts: [ | ||
| { | ||
| message: "What is the name of the new package?", | ||
| name: "name", | ||
| type: "input", | ||
| validate(input: string) { | ||
| if (input.includes(".")) { | ||
| return "library name cannot include an extension"; | ||
| } | ||
| if (input.includes(" ")) { | ||
| return "library name cannot include spaces"; | ||
| } | ||
| if (!input) { | ||
| return "library name is required"; | ||
| } | ||
| return true; | ||
| }, | ||
| }, | ||
| { | ||
| message: "What is the description of the new package?", | ||
| name: "description", | ||
| type: "input", | ||
| }, | ||
| ], | ||
| // eslint-disable-next-line | ||
| plop.setGenerator("cli", { | ||
| description: "Generate a new cli package", | ||
| prompts: [prompts.name, prompts.description], | ||
| actions: [actions.addTemplate({ type: "cli" }), actions.addAllCommon], | ||
| }); | ||
|
|
||
| plop.setGenerator("env", { | ||
| description: "Generate a new env package", | ||
| prompts: [prompts.name, prompts.description], | ||
| actions: [ | ||
| { | ||
| path: "{{ turbo.paths.root }}/core/{{ dashCase name }}/package.json", | ||
| templateFile: "templates/lib/package.json.hbs", | ||
| type: "add", | ||
| }, | ||
| { | ||
| path: "{{ turbo.paths.root }}/core/{{ dashCase name }}/README.md", | ||
| templateFile: "templates/lib/README.md.hbs", | ||
| type: "add", | ||
| }, | ||
| { | ||
| path: "{{ turbo.paths.root }}/core/{{ dashCase name }}/tsdown.config.ts", | ||
| templateFile: "templates/lib/tsdown.config.ts.hbs", | ||
| type: "add", | ||
| }, | ||
| { | ||
| path: "{{ turbo.paths.root }}/core/{{ dashCase name }}/tsconfig.json", | ||
| templateFile: "templates/lib/tsconfig.json.hbs", | ||
| type: "add", | ||
| }, | ||
| { | ||
| path: "{{ turbo.paths.root }}/core/{{ dashCase name }}/typedoc.json", | ||
| templateFile: "templates/lib/typedoc.json", | ||
| type: "add", | ||
| }, | ||
| { | ||
| path: "{{ turbo.paths.root }}/core/{{ dashCase name }}/src/index.ts", | ||
| templateFile: "templates/lib/BLANK", | ||
| type: "add", | ||
| }, | ||
| actions.addTemplate({ type: "env" }), | ||
| actions.addCommonFile("tsconfig.json"), | ||
| ], | ||
| }); | ||
|
|
||
| plop.setGenerator("lib", { | ||
| description: "Generate a new lib package", | ||
| prompts: [prompts.name, prompts.description], | ||
| actions: [actions.addTemplate({ type: "lib" }), actions.addAllCommon], | ||
| }); | ||
| } |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| "use strict"; | ||
|
|
||
| import("./dist/index.js") | ||
| .then((mod) => mod.run()) | ||
| .catch((error) => { | ||
| console.error(error); | ||
| process.exit(1); | ||
| }); |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| { | ||
| "name": "@stephansama/{{name}}", | ||
| "version": "0.0.0", | ||
| "description": "{{description}}", | ||
| "keywords": [ | ||
| "{{name}}" | ||
| ], | ||
| "homepage": "https://packages.stephansama.info/api/@stephansama/{{name}}", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/stephansama/packages.git", | ||
| "directory": "core/{{name}}" | ||
| }, | ||
| "license": "MIT", | ||
| "author": { | ||
| "name": "Stephan Randle", | ||
| "email": "stephanrandle.dev@gmail.com", | ||
| "url": "https://stephansama.info" | ||
| }, | ||
| "type": "module", | ||
| "bin": "./cli.mjs", | ||
| "files": [ | ||
| "cli.mjs", | ||
| "dist" | ||
| ], | ||
| "scripts": { | ||
| "build": "tsdown", | ||
| "dev": "tsdown --watch", | ||
| "lint": "eslint ./ --pass-on-no-patterns --no-error-on-unmatched-pattern", | ||
| "lint:fix": "eslint ./ --fix" | ||
| }, | ||
| "publishConfig": { | ||
| "access": "public", | ||
| "provenance": true | ||
| }, | ||
| "readme": "./README.md" | ||
| } |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| export async function run() { | ||
| console.info("running cli {{name}}"); | ||
| } |
File renamed without changes.
This file contains hidden or 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
File renamed without changes.
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| { | ||
| "name": "@stephansama/{{name}}", | ||
| "version": "0.0.0", | ||
| "description": "{{description}}", | ||
| "homepage": "https://packages.stephansama.info/api/@stephansama/{{name}}", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/stephansama/packages.git", | ||
| "directory": "core/{{name}}" | ||
| }, | ||
| "license": "MIT", | ||
| "author": { | ||
| "name": "Stephan Randle", | ||
| "email": "stephanrandle.dev@gmail.com", | ||
| "url": "https://stephansama.info" | ||
| }, | ||
| "type": "module", | ||
| "files": [ | ||
| "src" | ||
| ], | ||
| "scripts": { | ||
| "lint": "eslint ./src", | ||
| "lint:fix": "eslint ./src --fix" | ||
| }, | ||
| "publishConfig": { | ||
| "access": "public", | ||
| "provenance": true | ||
| } | ||
| } |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| declare global { | ||
| namespace NodeJS { | ||
| interface ProcessEnv extends ExtendEnvironment {} | ||
| } | ||
| } | ||
|
|
||
| interface ExtendEnvironment {} | ||
|
|
||
| export {}; | ||
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Repository: stephansama/packages
Length of output: 740
🏁 Script executed:
Repository: stephansama/packages
Length of output: 1751
🏁 Script executed:
Repository: stephansama/packages
Length of output: 2357
Add Biome suppression comment for empty interface extension point.
The
noEmptyInterfacerule is enabled in this repository's Biome configuration and will flag the empty interface on Line 7. While the empty interface is an intentional template extension point, it requires a suppression comment to comply with linting.Proposed fix
📝 Committable suggestion
🧰 Tools
🪛 Biome (2.4.4)
[error] 7-7: An empty interface is equivalent to {}.
(lint/suspicious/noEmptyInterface)
🤖 Prompt for AI Agents