Skip to content
This repository has been archived by the owner on Jan 29, 2025. It is now read-only.

Commit

Permalink
Add documentation for projectName variable
Browse files Browse the repository at this point in the history
  • Loading branch information
esotericenderman committed Sep 8, 2024
1 parent 3097860 commit 1033fd5
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion scripts/rename-project.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
const commandLineArguments = process.argv.slice(2);

const projectName = commandLineArguments[0];
/**
* The new name of the project, as provided by the person running the command.
* This name is in [kebab-case](https://developer.mozilla.org/en-US/docs/Glossary/Kebab_case) format.
*
* The name is provided by running this command:
* `npm run rename-project -- new-project-name`
*
* Where `new-project-name` is replaced with the desired plugin name, in [kebab-case](https://developer.mozilla.org/en-US/docs/Glossary/Kebab_case) format.
**/
const projectName = commandLineArguments[0]; // npm run rename-project -- new-project-name

if (!projectName) {
console.error("A project name must be specified");
Expand Down

0 comments on commit 1033fd5

Please sign in to comment.