Skip to content

Commit

Permalink
build(package.json): added commitizen support
Browse files Browse the repository at this point in the history
attempting to add commitzen support (possibly enforcement)
  • Loading branch information
thkruz committed Jan 13, 2021
1 parent 8119cdb commit 860718c
Show file tree
Hide file tree
Showing 3 changed files with 218 additions and 9 deletions.
202 changes: 202 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
# Force the following filetypes to have unix eols, so Windows does not break them
*.* text eol=lf

## GITATTRIBUTES FOR WEB PROJECTS
#
# These settings are for any web project.
#
# Details per file setting:
# text These files should be normalized (i.e. convert CRLF to LF).
# binary These files are binary and should be left untouched.
#
# Note that binary is a macro for -text -diff.
######################################################################

# Auto detect
## Handle line endings automatically for files detected as
## text and leave all files detected as binary untouched.
## This will handle all files NOT defined below.
* text=auto

# Source code
*.bash text eol=lf
*.bat text eol=crlf
*.cmd text eol=crlf
*.coffee text
*.css text
*.htm text diff=html
*.html text diff=html
*.inc text
*.ini text
*.js text
*.json text
*.jsx text
*.less text
*.ls text
*.map text -diff
*.od text
*.onlydata text
*.php text diff=php
*.pl text
*.ps1 text eol=crlf
*.py text diff=python
*.rb text diff=ruby
*.sass text
*.scm text
*.scss text diff=css
*.sh text eol=lf
*.sql text
*.styl text
*.tag text
*.ts text
*.tsx text
*.xml text
*.xhtml text diff=html

# Docker
Dockerfile text

# Documentation
*.ipynb text
*.markdown text
*.md text
*.mdwn text
*.mdown text
*.mkd text
*.mkdn text
*.mdtxt text
*.mdtext text
*.txt text
AUTHORS text
CHANGELOG text
CHANGES text
CONTRIBUTING text
COPYING text
copyright text
*COPYRIGHT* text
INSTALL text
license text
LICENSE text
NEWS text
readme text
*README* text
TODO text

# Templates
*.dot text
*.ejs text
*.haml text
*.handlebars text
*.hbs text
*.hbt text
*.jade text
*.latte text
*.mustache text
*.njk text
*.phtml text
*.tmpl text
*.tpl text
*.twig text
*.vue text

# Configs
*.cnf text
*.conf text
*.config text
.editorconfig text
.env text
.gitattributes text
.gitconfig text
.htaccess text
*.lock text -diff
package-lock.json text -diff
*.toml text
*.yaml text
*.yml text
browserslist text
Makefile text
makefile text

# Heroku
Procfile text

# Graphics
*.ai binary
*.bmp binary
*.eps binary
*.gif binary
*.gifv binary
*.ico binary
*.jng binary
*.jp2 binary
*.jpg binary
*.jpeg binary
*.jpx binary
*.jxr binary
*.pdf binary
*.png binary
*.psb binary
*.psd binary
# SVG treated as an asset (binary) by default.
*.svg text
# If you want to treat it as binary,
# use the following line instead.
# *.svg binary
*.svgz binary
*.tif binary
*.tiff binary
*.wbmp binary
*.webp binary

# Audio
*.kar binary
*.m4a binary
*.mid binary
*.midi binary
*.mp3 binary
*.ogg binary
*.ra binary

# Video
*.3gpp binary
*.3gp binary
*.as binary
*.asf binary
*.asx binary
*.fla binary
*.flv binary
*.m4v binary
*.mng binary
*.mov binary
*.mp4 binary
*.mpeg binary
*.mpg binary
*.ogv binary
*.swc binary
*.swf binary
*.webm binary

# Archives
*.7z binary
*.gz binary
*.jar binary
*.rar binary
*.tar binary
*.zip binary

# Fonts
*.ttf binary
*.eot binary
*.otf binary
*.woff binary
*.woff2 binary

# Executables
*.exe binary
*.pyc binary

# RC files (like .babelrc or .eslintrc)
*.*rc text

# Ignore files (like .npmignore or .gitignore)
*.*ignore text
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,39 +35,39 @@ In December 2020 I set out to rewrite satellite.js to realign it with the most r
Install the library with [NPM](https://www.npmjs.com/):

```bash
npm install satellite.js
npm install ootk
```

## Usage

### Common.js ([Node.js](https://nodejs.org))

```js
var satellite = require('satellite.js');
var ootk = require('ootk.js');
...
var positionAndVelocity = satellite.sgp4(satrec, time);
var positionAndVelocity = ootk.Sgp4.propagate(satrec, time);
```

### ES ([Babel.js](https://babeljs.io/))

```js
import { sgp4 } from 'satellite.js';
import { ootk } from 'ootk.es.js';
...
const positionAndVelocity = sgp4(satrec, time);
const positionAndVelocity = ootk.Sgp4.propagate(satrec, time);
```

### Script tag

Include `dist/satellite.min.js` as a script in your html:
Include `dist/ootk.min.js` as a script in your html:

```html
<script src="path/to/dist/satellite.min.js"></script>
<script src="path/to/dist/ootk.min.js"></script>
```

`satellite` object will be available in global scope:
`ootk` object will be available in global scope:

```js
var positionAndVelocity = satellite.sgp4(satrec, time);
var positionAndVelocity = ootk.Sgp4.propagate(satrec, time);
```

## Sample Usage
Expand Down
7 changes: 7 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@
"@typescript-eslint/parser": "^4.13.0",
"babel-eslint": "^10.1.0",
"babel-loader": "^8.2.2",
"commitizen": "^4.2.2",
"cz-conventional-changelog": "^3.3.0",
"eslint": "^7.9.0",
"html-loader": "^1.3.2",
"jest": "^26.4.2",
Expand All @@ -68,5 +70,10 @@
"directories": {
"lib": "lib",
"test": "test"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
}
}

0 comments on commit 860718c

Please sign in to comment.