Skip to content

Commit d3b8242

Browse files
0-vortex0-vortex
committed
feat: initial commit
0 parents  commit d3b8242

13 files changed

+14564
-0
lines changed

‎.czrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"path": "./node_modules/cz-conventional-changelog"
3+
}

‎.editorconfig

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
end_of_line = lf
7+
charset = utf-8
8+
max_line_length = 120
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
max_line_length = 0
14+
trim_trailing_whitespace = false

‎.gitattributes

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
*.pbxproj -text
2+
* text eol=lf
3+
4+
## DOCKER
5+
*.dockerignore text
6+
Dockerfile text
7+
8+
## DOCUMENTATION
9+
*.markdown text
10+
*.md text
11+
*.mdwn text
12+
*.mdown text
13+
*.mkd text
14+
*.mkdn text
15+
*.mdtxt text
16+
*.mdtext text
17+
*.txt text
18+
AUTHORS text
19+
CHANGELOG text
20+
CHANGES text
21+
CONTRIBUTING text
22+
COPYING text
23+
copyright text
24+
*COPYRIGHT* text
25+
INSTALL text
26+
license text
27+
LICENSE text
28+
NEWS text
29+
readme text
30+
*README* text
31+
TODO text
32+
33+
## CONFIGS
34+
*.bowerrc text
35+
*.cnf text
36+
*.conf text
37+
*.config text
38+
.browserslistrc text
39+
.editorconfig text
40+
.gitattributes text
41+
.gitconfig text
42+
.htaccess text
43+
*.npmignore text
44+
*.yaml text
45+
*.yml text
46+
browserslist text
47+
Makefile text
48+
makefile text
49+
50+
## GRAPHICS
51+
*.ai binary
52+
*.bmp binary
53+
*.eps binary
54+
*.gif binary
55+
*.ico binary
56+
*.jng binary
57+
*.jp2 binary
58+
*.jpg binary
59+
*.jpeg binary
60+
*.jpx binary
61+
*.jxr binary
62+
*.pdf binary
63+
*.png binary
64+
*.psb binary
65+
*.psd binary
66+
*.svg text
67+
*.svgz binary
68+
*.tif binary
69+
*.tiff binary
70+
*.wbmp binary
71+
*.webp binary
72+
73+
## FONTS
74+
*.ttf binary
75+
*.eot binary
76+
*.otf binary
77+
*.woff binary
78+
*.woff2 binary

‎.github/workflows/compliance.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: "Compliance"
2+
3+
on:
4+
pull_request_target:
5+
types:
6+
- opened
7+
- edited
8+
- synchronize
9+
10+
permissions:
11+
pull-requests: write
12+
13+
jobs:
14+
compliance:
15+
uses: open-sauced/open-sauced/.github/workflows/compliance.yml@main

‎.github/workflows/release.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: "Release"
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
release:
10+
environment:
11+
name: npm
12+
url: https://www.npmjs.com/package/@${{ github.repository }}/v/${{ steps.release.outputs.version }}
13+
name: Semantic release
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: "☁️ checkout repository"
17+
uses: actions/checkout@v2
18+
with:
19+
fetch-depth: 0
20+
21+
- name: "🔧 setup node"
22+
uses: actions/[email protected]
23+
with:
24+
node-version: 14
25+
26+
- name: "🔧 setup cache"
27+
uses: actions/cache@v2
28+
with:
29+
path: ~/.npm
30+
key: ${{ runner.os }}-node-${{ hashFiles('**/npm-shrinkwrap.json', '**/package-lock.json') }}
31+
restore-keys: |
32+
${{ runner.os }}-node-
33+
34+
- name: "🔧 install npm@latest"
35+
run: npm i -g npm@latest
36+
37+
- name: "📦 install dependencies"
38+
run: npm ci
39+
40+
- name: "🚀 release"
41+
id: release
42+
env:
43+
DISABLE_DOCKER: true
44+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
45+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
46+
GIT_AUTHOR_NAME: ${{ github.event.commits[0].author.username }}
47+
GIT_AUTHOR_EMAIL: ${{ github.event.commits[0].author.email }}
48+
GIT_COMMITTER_NAME: ${{ secrets.GIT_COMMITTER_NAME }}
49+
GIT_COMMITTER_EMAIL: ${{ secrets.GIT_COMMITTER_EMAIL }}
50+
run: |
51+
npm run semantic-release
52+
echo "::set-output name=version::$(cat package.json | jq -r '.version')"

‎.gitignore

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
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+
90+
# vuepress build output
91+
.vuepress/dist
92+
93+
# Serverless directories
94+
.serverless/
95+
96+
# FuseBox cache
97+
.fusebox/
98+
99+
# DynamoDB Local files
100+
.dynamodb/
101+
102+
# TernJS port file
103+
.tern-port
104+
105+
build

‎.npmrc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
save-exact=false
2+
audit=false
3+
audit-level="moderate"
4+
loglevel="info"
5+
progress=false
6+
timing=false

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Open Sauced
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.

‎README.md

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<div style="text-align: center" align="center">
2+
<img alt="Open Sauced" src="https://i.ibb.co/7jPXt0Z/logo1-92f1a87f.png" width="300px" />
3+
4+
# @open-sauced/conventional-commit
5+
6+
> Never miss a conventional commit with [**commitizen**](https://www.npmjs.com/package/npm-install-checks) running on [**npx**](https://www.npmjs.com/package/commitizen).
7+
8+
[![Commits](https://img.shields.io/github/commit-activity/w/open-sauced/conventional-commit?style=flat)](https://github.com/open-sauced/conventional-commit/pulse)
9+
[![Issues](https://img.shields.io/github/issues/open-sauced/conventional-commit.svg?style=flat)](https://github.com/open-sauced/conventional-commit/issues)
10+
[![Releases](https://img.shields.io/github/v/release/open-sauced/conventional-commit.svg?style=flat)](https://github.com/open-sauced/conventional-commit/releases)
11+
[![Discord](https://img.shields.io/discord/714698561081704529.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/U2peSNf23P)
12+
[![Twitter](https://img.shields.io/twitter/follow/saucedopen?label=Follow&style=social)](https://twitter.com/saucedopen)
13+
14+
</div>
15+
16+
## 📦 Install
17+
18+
This package is binary and doesn't require installation however you can add it to your repository as a `devDependency`:
19+
20+
```shell
21+
npm install --save-dev @open-sauced/conventional-commit
22+
```
23+
24+
## 🚀 Usage
25+
26+
All you have to do is run the script next to your `package.json`:
27+
28+
```shell
29+
npx @open-sauced/conventional-commit
30+
# or
31+
npx conventional-commit
32+
```
33+
34+
## 🔧 Configuration
35+
36+
The most common use case for this package is to run it instead of the `git commit` command inside your `npm` scripts:
37+
38+
```json
39+
{
40+
"scripts": {
41+
"push": "npx @open-sauced/conventional-commit"
42+
}
43+
}
44+
```
45+
46+
or
47+
48+
```json
49+
{
50+
"scripts": {
51+
"push": "npx conventional-commit"
52+
}
53+
}
54+
```
55+
56+
If you want to ensure local-only usage:
57+
58+
```json
59+
{
60+
"scripts": {
61+
"push": "conventional-commit"
62+
}
63+
}
64+
```
65+
66+
## 🤝 Contributing
67+
68+
We encourage you to contribute to Open Sauced! Please check out the [Contributing guide](https://docs.opensauced.pizza/) for guidelines about how to proceed.
69+
70+
If you decide to fix a bug, make sure to use the conventional commit available at:
71+
72+
```shell
73+
npm run push
74+
```
75+
76+
<img align="right" src="https://i.ibb.co/CJfW18H/ship.gif" width="200"/>
77+
78+
## 🍕 Community
79+
80+
Got Questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P).
81+
Find Open Sauced videos and release overviews on our [YouTube Channel](https://www.youtube.com/channel/UCklWxKrTti61ZCROE1e5-MQ).
82+
83+
## ⚖️ LICENSE
84+
85+
MIT © [Open Sauced](LICENSE)

0 commit comments

Comments
 (0)