Skip to content

Commit 2efac42

Browse files
committed
feat: initial commit, npm and github actions setup
0 parents  commit 2efac42

File tree

13 files changed

+2337
-0
lines changed

13 files changed

+2337
-0
lines changed

.editorconfig

Lines changed: 14 additions & 0 deletions
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

Lines changed: 78 additions & 0 deletions
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/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @TMCB-SPACE @0-vortex

.github/workflows/compliance.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: "Compliance"
2+
3+
on:
4+
pull_request_target:
5+
types:
6+
- opened
7+
- edited
8+
- synchronize
9+
- reopened
10+
11+
jobs:
12+
compliance:
13+
uses: TMCB-SPACE/.github/.github/workflows/compliance.yml@main

.github/workflows/development.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: "Development"
2+
3+
on:
4+
pull_request:
5+
types:
6+
- opened
7+
- edited
8+
- synchronize
9+
- reopened
10+
workflow_call:
11+
12+
jobs:
13+
development:
14+
uses: TMCB-SPACE/.github/.github/workflows/development.yml@main

.github/workflows/release.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: "Release"
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
concurrency:
9+
group: release-${{ github.ref }}
10+
cancel-in-progress: true
11+
12+
jobs:
13+
setup:
14+
name: Set environment variables
15+
runs-on: ubuntu-latest
16+
outputs:
17+
DEPLOY_ENVIRONMENT: ${{ steps.env.outputs.DEPLOY_ENVIRONMENT }}
18+
steps:
19+
- name: "☁️ compute environment variables"
20+
id: env
21+
run: |
22+
echo "DEPLOY_ENVIRONMENT=$([[ ${{ github.ref_name }} == 'main' ]] && echo 'production' || echo ${{ github.ref_name }})" >> $GITHUB_OUTPUT
23+
24+
test:
25+
name: Test and lint
26+
uses: ./.github/workflows/development.yml
27+
28+
release:
29+
environment:
30+
name: ${{ needs.setup.outputs.DEPLOY_ENVIRONMENT }}
31+
url: https://github.com/${{ github.repository }}/releases/tag/${{ steps.semantic-release.outputs.release-tag }}
32+
outputs:
33+
release-tag: ${{ steps.semantic-release.outputs.release-tag }}
34+
name: Semantic release
35+
needs:
36+
- setup
37+
- test
38+
runs-on: ubuntu-latest
39+
steps:
40+
- name: "☁️ checkout repository"
41+
uses: actions/checkout@v4
42+
with:
43+
fetch-depth: 0
44+
45+
- name: "🚀 release"
46+
id: semantic-release
47+
uses: tmcb-space/release@v1
48+
env:
49+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
50+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

Lines changed: 105 additions & 0 deletions
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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
audit=false
2+
audit-level="moderate"
3+
engine-strict=true
4+
format-package-lock=true
5+
lockfile-version=3
6+
loglevel="info"
7+
prefer-offline=false
8+
progress=false
9+
save-exact=false
10+
timing=false
11+
update-notifier=false
12+
yes=true
13+
prefer-dedupe=true
14+
fund=false

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) 2023 TED (Teodor-Eugen Dutulescu) Vortex
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

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<div align="center">
2+
<img src="https://gist.githubusercontent.com/0-vortex/3ba0d05bcd4afdbd0f2bf20542caf682/raw/02c432297a6822cd2944a41b9cc9986357d49748/His_Worshipful_Grace-1.svg" width="400">
3+
4+
# @tmcb/conventional-commit
5+
6+
> Never miss a conventional commit with [**commitizen**](https://github.com/commitizen/cz-cli) running on [**npx**](https://www.npmjs.com/package/npx).
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+
12+
</div>
13+
14+
## 📦 Install
15+
16+
This package is binary and doesn't require installation however you can add it to your repository as a `devDependency`:
17+
18+
```shell
19+
npm install --save-dev @tmcb/conventional-commit
20+
```
21+
22+
## 🚀 Usage
23+
24+
All you have to do is run the script next to your `package.json`:
25+
26+
```shell
27+
npx @tmcb/conventional-commit
28+
# or
29+
npx conventional-commit
30+
```
31+
32+
## 🔧 Configuration
33+
34+
The most common use case for this package is to run it instead of the `git commit` command inside your `npm` scripts:
35+
36+
```json
37+
{
38+
"scripts": {
39+
"push": "npx @tmcb/conventional-commit"
40+
}
41+
}
42+
```
43+
44+
or
45+
46+
```json
47+
{
48+
"scripts": {
49+
"push": "npx conventional-commit"
50+
}
51+
}
52+
```
53+
54+
If you want to ensure local-only usage:
55+
56+
```json
57+
{
58+
"scripts": {
59+
"push": "conventional-commit"
60+
}
61+
}
62+
```
63+
64+
## 🤝 Contributing
65+
66+
If you decide to fix a bug, make sure to use the conventional commit available at:
67+
68+
```shell
69+
npm run push
70+
```
71+
72+
## ⚖️ LICENSE
73+
74+
MIT © [TED (Teodor-Eugen Dutulescu) Vortex](./LICENSE)

0 commit comments

Comments
 (0)