ptkdev-boilerplate / node-cli-boilerplate

🪓 Create node cli with this user friendly boilerplate

🪓 node-cli-boilerplate

Create node cli with this user friendly boilerplate. Use this respository as template for your new npm command line interface project

This is a github template, you can fork it or use as template for start new project with this repository as hello-world. I hate start new project with empty template, often i missing correct configuration, readme instruction or i need of samples of code. Use this repository as template solve this problem.

🎁 Support: Donate

This project is free, open source and I try to provide excellent free support. Why donate? I work on this project several hours in my spare time and try to keep it up to date and working. THANK YOU!

📎 Menu

• 💡 Features
• 🚀 How to use
• 📚 Documentation
• 🔨 Developer Mode
• • 🏁 Run Project
• • 💾 Setup Project
• • 🚀 Deploy
• 👨‍💻 Contributing
• 🐛 Known Bugs
• 🍻 Community:
  • Telegram (🇬🇧 English | 🇮🇹 Italian)
  • Discord (🇬🇧 English | 🇮🇹 Italian | 🇵🇱 Polish)
  • Twitter

💡 Features

• [✔️] Easy to use
• [✔️] MIT License
• [✔️] Make CLI Package for npm
• [✔️] Friendly boilerplate + Github templates
• [✔️] Typescript + TSPaths preconfigured
• [✔️] Userfriendly folders tree
• [✔️] Prettiers and ESLint preconfigured
• [✔️] all-contributors-cli and all-shields-cli preconfigured
• [✔️] JEST Test preconfigured
• [✔️] Full async code
• [✔️] Github and Vscode dotfiles preconfigured
• [✔️] Translations: 🇬🇧 🇮🇹 🇵🇱 (Help me ❤️)

🚀 Usage

1. Install cli package globally: npm install @ptkdev/node-cli-boilerplate -g
2. Run anywhere: node-cli-boilerplate

You can use npx, example: npx @ptkdev/node-cli-boilerplate

🔨 Developer Mode

🏁 Run Project

1. Clone this repository or download nightly, beta or stable.
2. Run npm install
3. Run npm run dev for watch mode

If you want to try cli locally:

4. Run npm run release
5. Run npm link (on unix/mac use sudo npm link)
6. Run node-cli-boilerplate anywhere for execute command line tool

For uninstall it run npm unlink (on unix/mac use sudo npm unlink)

💾 Setup Project

If you want replace all strings (example: package name, author, urls, etc...) in markdown file, source files and others files of this project you need edit setup.json with correct values and run npm run setup.

🚀 Deploy

For create npm package:

• Run npm run release
• Run npm publish

📚 Documentation

Run npm run docs

👑 Backers and Sponsors

Thanks to all our backers! 🙏 Donate 3$ or more on paypal, ko-fi or github and send me email with your avatar and url.

👨‍💻 Contributing

I ❤️ contributions! I will happily accept your pull request! (IMPORTANT: Only to nightly branch!) Translations, grammatical corrections (GrammarNazi you are welcome! Yes my English is bad, sorry), etc... Do not be afraid, if the code is not perfect we will work together 👯 and remember to insert your name in .all-contributorsrc and package.json file.

Thanks goes to these wonderful people (emoji key):

Patryk Rzucidło 💻 🌍 📖 🐛

💰 In the future, if the donations allow it, I would like to share some of the success with those who helped me the most. For me open source is share of code, share development knowledges and share donations!

🦄 Other Projects

💫 License

• Code and Contributions have MIT License
• Images and logos have CC BY-NC 4.0 License
• Documentations and Translations have CC BY 4.0 License

Copyleft (c) 2024 Patryk Rzucidło (@PTKDev) <[email protected]>

node-cli-boilerplate's Issues

Missing dependency during build process

Versions

• App Version: v2.0.2
• Node Version: v14.19.1
• Operating System: Ubuntu 20.04
• Browser: N/A

Expected Behavior

Run the npm run build without errors.

Actual Behavior

There is an error during the build process.

$ npm run build

> @ptkdev/[email protected] build /<path>
> tsc

app/translations/translate.ts:10:21 - error TS2307: Cannot find module '@configs/config' or its corresponding type declarations.

10 import configs from "@configs/config";
                       ~~~~~~~~~~~~~~~~~

app/utils/logger.ts:12:20 - error TS2307: Cannot find module '@configs/config' or its corresponding type declarations.

12 import config from "@configs/config";
                      ~~~~~~~~~~~~~~~~~


Found 2 errors.

npm ERR! code ELIFECYCLE
npm ERR! errno 2
npm ERR! @ptkdev/[email protected] build: `tsc`
npm ERR! Exit status 2
npm ERR! 
npm ERR! Failed at the @ptkdev/[email protected] build script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /<path>/.npm/_logs/2022-04-04T17_11_13_979Z-debug.log

Steps to Reproduce

1. Run npm install
2. Run npm run build

Evidences

$ npm install
npm WARN read-shrinkwrap This version of npm is compatible with lockfileVersion@1, but package-lock.json was generated for lockfileVersion@2. I'll try to do my best with it!

> [email protected] postinstall /<path>/node_modules/nodemon
> node bin/postinstall || exit 0


> @ptkdev/[email protected] prepare /<path>
> ts-patch install -s && husky install

husky - Git hooks installed
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/livereload/node_modules/fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

added 1003 packages from 630 contributors in 41.758s

75 packages are looking for funding
  run `npm fund` for details