Skip to content

Commit 751cd63

Browse files
phatpham9phatpham9
committed
feat(generators/app): add .gitignore, LICENSE & README.md to templates
1 parent ff153b7 commit 751cd63

File tree

4 files changed

+197
-6
lines changed

4 files changed

+197
-6
lines changed

‎README.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,14 @@ $ yo create-package
7474
This scaffolds out:
7575

7676
```
77+
├── .husky
7778
├── src
78-
│   ├── index.ts
79-
├── .eslintrc.js
80-
├── .huskyrc
81-
├── .lintstagedrc
82-
├── .prettierrc.js
79+
│   └── index.ts
80+
├── .gitignore
8381
├── package.json
82+
├── README.md
8483
├── rollup.config.js
85-
├── tsconfig.json
84+
└── tsconfig.json
8685
```
8786

8887
## Contributing

‎generators/app/templates/.gitignore‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
9+
# Diagnostic reports (https://nodejs.org/api/report.html)
10+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11+
12+
# Runtime data
13+
pids
14+
*.pid
15+
*.seed
16+
*.pid.lock
17+
18+
# Directory for instrumented libs generated by jscoverage/JSCover
19+
lib-cov
20+
21+
# Coverage directory used by tools like istanbul
22+
coverage
23+
*.lcov
24+
25+
# nyc test coverage
26+
.nyc_output
27+
28+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29+
.grunt
30+
31+
# Bower dependency directory (https://bower.io/)
32+
bower_components
33+
34+
# node-waf configuration
35+
.lock-wscript
36+
37+
# Compiled binary addons (https://nodejs.org/api/addons.html)
38+
build/Release
39+
40+
# Dependency directories
41+
node_modules/
42+
jspm_packages/
43+
44+
# TypeScript v1 declaration files
45+
typings/
46+
47+
# TypeScript cache
48+
*.tsbuildinfo
49+
50+
# Optional npm cache directory
51+
.npm
52+
53+
# Optional eslint cache
54+
.eslintcache
55+
56+
# Microbundle cache
57+
.rpt2_cache/
58+
.rts2_cache_cjs/
59+
.rts2_cache_es/
60+
.rts2_cache_umd/
61+
62+
# Optional REPL history
63+
.node_repl_history
64+
65+
# Output of 'npm pack'
66+
*.tgz
67+
68+
# Yarn Integrity file
69+
.yarn-integrity
70+
71+
# dotenv environment variables file
72+
.env
73+
.env.test
74+
75+
# parcel-bundler cache (https://parceljs.org/)
76+
.cache
77+
78+
# Next.js build output
79+
.next
80+
81+
# Nuxt.js build / generate output
82+
.nuxt
83+
dist
84+
85+
# Gatsby files
86+
.cache/
87+
# Comment in the public line in if your project uses Gatsby and *not* Next.js
88+
# https://nextjs.org/blog/next-9-1#public-directory-support
89+
# public
90+
91+
# vuepress build output
92+
.vuepress/dist
93+
94+
# Serverless directories
95+
.serverless/
96+
97+
# FuseBox cache
98+
.fusebox/
99+
100+
# DynamoDB Local files
101+
.dynamodb/
102+
103+
# TernJS port file
104+
.tern-port
105+
106+
# BoringCodes build output
107+
build

‎generators/app/templates/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 <%- elementOrganizationName %>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎generators/app/templates/README.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<div align="center">
2+
<h1><%= elementName %></h1>
3+
<p><%= elementDescription %>e</p>
4+
5+
<div>
6+
<a href="https://github.com/<%= elementOrganizationName %>/<%= elementName %>/commits" aria-label="Commitizen Friendly">
7+
<img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square">
8+
</a>
9+
<a href="https://github.com/<%= elementOrganizationName %>/<%= elementName %>" aria-label="Prettier Code Style">
10+
<img src="https://img.shields.io/badge/code_style-prettier-brightgreen?style=flat-square">
11+
</a>
12+
<a href="https://github.com/<%= elementOrganizationName %>/<%= elementName %>/actions" aria-label="Lint Status">
13+
<img src="https://img.shields.io/github/workflow/status/<%= elementOrganizationName %>/<%= elementName %>/lint-source?style=flat-square&label=lint">
14+
</a>
15+
<a href="https://github.com/<%= elementOrganizationName %>/<%= elementName %>/actions" aria-label="Build Status">
16+
<img src="https://img.shields.io/github/workflow/status/<%= elementOrganizationName %>/<%= elementName %>/build-source?style=flat-square">
17+
</a>
18+
<a href="https://david-dm.org/<%= elementOrganizationName %>/<%= elementName %>" aria-label="Dependencies Status">
19+
<img src="https://img.shields.io/david/<%= elementOrganizationName %>/<%= elementName %>?style=flat-square">
20+
</a>
21+
<a href="https://www.npmjs.com/package/@<%= elementOrganizationName %>/<%= elementName %>" aria-label="NPM Version">
22+
<img src="https://img.shields.io/npm/v/@<%= elementOrganizationName %>/<%= elementName %>?color=brightgreen&style=flat-square">
23+
</a>
24+
<a href="https://www.npmjs.com/package/@<%= elementOrganizationName %>/<%= elementName %>" aria-label="NPM Downloads">
25+
<img src="https://img.shields.io/npm/dm/@<%= elementOrganizationName %>/<%= elementName %>?style=flat-square">
26+
</a>
27+
<a href="https://github.com/<%= elementOrganizationName %>/<%= elementName %>/blob/master/LICENSE" aria-label="MIT License">
28+
<img src="https://img.shields.io/github/license/<%= elementOrganizationName %>/<%= elementName %>?color=brightgreen&style=flat-square">
29+
</a>
30+
<a href="https://github.com/boringcodes" aria-label="BoringCodes Verified">
31+
<img src="https://img.shields.io/badge/boringcodes-verified-brightgreen?style=flat-square">
32+
</a>
33+
</div>
34+
</div>
35+
36+
## Installation
37+
38+
Use the package manager to install `<%= elementName %>`
39+
40+
```bash
41+
yarn add <%= elementName %>
42+
```
43+
44+
## Usage
45+
46+
```javascript
47+
import foo from '<%= elementName %>';
48+
49+
foo();
50+
```
51+
52+
## Contributing
53+
54+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
55+
56+
Please make sure to update tests as appropriate.
57+
58+
## Authors
59+
60+
<%- elementAuthor %>
61+
62+
## License
63+
64+
[MIT](https://github.com/<%= elementOrganizationName %>/<%= elementName %>/blob/master/LICENSE)

0 commit comments

Comments
 (0)