Skip to content

Commit 6cceb7d

Browse files
committed
[Release] v1.0.20210330
1 parent 8f0dd84 commit 6cceb7d

File tree

20 files changed

+1865
-1696
lines changed

20 files changed

+1865
-1696
lines changed

.gitignore

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,11 +121,6 @@ npm-debug.log
121121

122122
# App #
123123
#######
124-
config.js
125-
config/*.js
126-
configs/*.js
127-
config.ts
128-
config/*.ts
129-
configs/*.ts
124+
/app/configs/config.js
130125
/dist
131126
/build

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
**/*
22
!/dist/**/*
3+
!/extra/**/*
34
!*.md
45
!package*.json

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# v1.0.20210329 (March 29, 2021)
1+
# v1.0.20210330 (March 30, 2021)
22

33
- First release
44

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# 🚀 node-cli-boilerplate
22

33
<!-- all-shields/header-badges:START -->
4-
[![v1.0.20210329](https://img.shields.io/badge/version-v1.0.20210329-lightgray.svg?style=flat&logo=)](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/blob/main/CHANGELOG.md) [![](https://img.shields.io/npm/v/@ptkdev-boilerplate/node-cli-boilerplate?color=CC3534&logo=npm)](https://www.npmjs.com/package/@ptkdev-boilerplate/node-cli-boilerplate) [![License: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat&logo=license)](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/blob/main/LICENSE.md) [![Language: TypeScript](https://img.shields.io/badge/language-typescript-blue.svg?style=flat&logo=typescript)](https://www.typescriptlang.org/) [![ECMAScript: 2019](https://img.shields.io/badge/ES-9-F7DF1E.svg?style=flat&logo=javascript)](https://github.com/tc39/ecma262) [![Discord Server](https://discordapp.com/api/guilds/383373985666301975/embed.png)](https://discord.ptkdev.io)
4+
[![v1.0.20210330](https://img.shields.io/badge/version-v1.0.20210330-lightgray.svg?style=flat&logo=)](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/blob/main/CHANGELOG.md) [![](https://img.shields.io/npm/v/@ptkdev-boilerplate/node-cli-boilerplate?color=CC3534&logo=npm)](https://www.npmjs.com/package/@ptkdev-boilerplate/node-cli-boilerplate) [![License: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat&logo=license)](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/blob/main/LICENSE.md) [![Language: TypeScript](https://img.shields.io/badge/language-typescript-blue.svg?style=flat&logo=typescript)](https://www.typescriptlang.org/) [![ECMAScript: 2019](https://img.shields.io/badge/ES-9-F7DF1E.svg?style=flat&logo=javascript)](https://github.com/tc39/ecma262) [![Discord Server](https://discordapp.com/api/guilds/383373985666301975/embed.png)](https://discord.ptkdev.io)
55
<!-- all-shields/header-badges:END -->
66

77
Create your node module (library) with this friendly boilerplate.
@@ -27,6 +27,16 @@ Create your node module (library) with this friendly boilerplate.
2727

2828
- [✔️] Easy to use
2929
- [✔️] MIT License
30+
- [✔️] Make CLI Package for npm
31+
- [✔️] Friendly boilerplate + Github templates
32+
- [✔️] Typescript + TSPaths preconfigured
33+
- [✔️] Userfriendly folders tree
34+
- [✔️] Prettiers and ESLint preconfigured
35+
- [✔️] all-contributors-cli and all-shields-cli preconfigured
36+
- [✔️] JEST Test preconfigured
37+
- [✔️] Full async code
38+
- [✔️] i18n translations
39+
- [✔️] Github and Vscode dotfiles preconfigured
3040

3141
## 🔨 Developer Mode
3242

@@ -90,7 +100,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
90100
## 💫 License
91101

92102
- Code and Contributions have **MIT License**
93-
- Images and logos have **CC BY-NC 4.0 License** ([Freepik](https://it.freepik.com/) Premium License)
103+
- Images and logos have **CC BY-NC 4.0 License**
94104
- Documentations and Translations have **CC BY 4.0 License**
95105

96106
###### Copyleft (c) 2021 [Patryk Rzucidło](https://ptk.dev) ([@PTKDev](https://twitter.com/ptkdev)) <[support@ptkdev.io](mailto:support@ptkdev.io)>

app/cli/cli.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@
99
* @license: MIT License
1010
*
1111
*/
12-
import m from "../functions/module";
12+
import m from "@app/functions/module";
13+
import configs from "@configs/config";
1314

1415
(async () => {
1516
const { app } = await m({ text: "hello-world" });
1617

1718
console.log(app());
19+
console.log(`debug: ${configs.debug}`);
1820
})();

app/functions/module.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* @license: MIT License
99
*
1010
*/
11-
import type { ModuleInterface, ModuleResponseInterface } from "../types/module.type";
11+
import type { ModuleInterface, ModuleResponseInterface } from "@app/types/module.type";
1212

1313
/**
1414
* Hello World
@@ -18,7 +18,6 @@ import type { ModuleInterface, ModuleResponseInterface } from "../types/module.t
1818
* @param {string} text - input string
1919
*
2020
* @return {Promise<ModuleResponseInterface>} fn - output string (async), run app()
21-
2221
*/
2322
export default async ({ text }: ModuleInterface): Promise<ModuleResponseInterface> => {
2423
const app = () => text;

app/routes/translations.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
* @license: MIT License
99
*
1010
*/
11-
// import en from "../../translations/en.json";
12-
// import it from "../../translations/it.json";
13-
export { };
11+
import en from "@translations/en.json";
12+
import it from "@translations/it.json";
13+
14+
export default { en, it };

app/tests/module.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* @license: MIT License
88
*
99
*/
10-
import m from "../functions/module";
10+
import m from "@app/functions/module";
1111

1212
test("show hello world", async () => {
1313
const { app } = await m({ text: "hello-world" });

0 commit comments

Comments
 (0)