Skip to content

Commit 7bbb5da

Browse files
author
Timo Bechtel
committed
feat: initial commit
0 parents  commit 7bbb5da

14 files changed

+11501
-0
lines changed

‎.eslintrc.js

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
module.exports = {
2+
env: {
3+
browser: true,
4+
es6: true,
5+
node: true,
6+
},
7+
parserOptions: {
8+
ecmaVersion: 2019,
9+
sourceType: 'module',
10+
},
11+
extends: ['eslint:recommended'],
12+
};

‎.github/workflows/release.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
release:
10+
name: Release
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v1
15+
- name: Setup Node.js
16+
uses: actions/setup-node@v1
17+
with:
18+
node-version: 12
19+
- name: Install dependencies
20+
run: npm ci
21+
- name: Test
22+
run: npm test
23+
env:
24+
CI: true
25+
- name: Publish
26+
env:
27+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
28+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
29+
run: npx semantic-release

‎.github/workflows/test.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Test
2+
3+
on: pull_request
4+
5+
jobs:
6+
test:
7+
name: Test
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v1
12+
- name: Setup Node.js
13+
uses: actions/setup-node@v1
14+
with:
15+
node-version: 12
16+
- name: Install dependencies
17+
run: npm ci
18+
- name: Test
19+
run: npm test
20+
env:
21+
CI: true

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
dist
3+
.vscode

‎.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
access = 'public'

‎.prettierrc.js

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
module.exports = {
2+
tabWidth: 2,
3+
semi: true,
4+
singleQuote: true,
5+
trailingComma: 'es5',
6+
};

‎.releaserc.json

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"plugins": [
3+
"@semantic-release/commit-analyzer",
4+
"@semantic-release/release-notes-generator",
5+
"@semantic-release/changelog",
6+
"@semantic-release/npm",
7+
"@semantic-release/git",
8+
"@semantic-release/github"
9+
]
10+
}

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Timo Bechtel
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

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
<h1 align="center">@compactjs/limit</h1>
2+
<h3 align="center">Limits a value to a defined range</h3>
3+
<p align="center">
4+
<a href="https://www.npmjs.com/package/@compactjs/limit" target="_blank">
5+
<img alt="Version" src="https://img.shields.io/npm/v/@compactjs/limit.svg">
6+
</a>
7+
<a href="https://github.com/CompactJS/limit/blob/master/LICENSE" target="_blank">
8+
<img alt="License: MIT" src="https://img.shields.io/github/license/CompactJS/limit" />
9+
</a>
10+
</p>
11+
<p align="center">
12+
·
13+
<a href="https://github.com/CompactJS/limit#readme">Homepage</a>
14+
·
15+
<a href="https://github.com/CompactJS/limit/issues">Report Bug / Request Feature</a>
16+
·
17+
</p>
18+
19+
<p align="center">
20+
</p>
21+
22+
## Table of Contents
23+
24+
- [About](#What-it-does)
25+
- [Installation](#Install)
26+
- [Usage](#usage)
27+
- [Test](#run-tests)
28+
- [Contact](#contact)
29+
- [Contributing](#Contributing)
30+
- [License](#license)
31+
32+
## What it does
33+
34+
@compactjs/limit limits any number to a given range. If it exceeds the range, it start back at 0 and equally starts from maximum value if it falls below 0.
35+
36+
Use it to easily calculate hours, minutes or degrees.
37+
38+
## Install
39+
40+
### NPM:
41+
42+
```sh
43+
npm install @compactjs/limit
44+
```
45+
46+
### CDN:
47+
48+
```html
49+
<script src="https://unpkg.com/@compactjs/limit/dist/index.umd.js"></script>
50+
```
51+
52+
53+
## Usage
54+
55+
### As module:
56+
57+
```javascript
58+
import { limit } from '@compactjs/limit';
59+
```
60+
61+
### Example:
62+
63+
```javascript
64+
// hours
65+
limit(25, 24); // returns: 1
66+
67+
// degrees
68+
limit(90 - 180, 360); // returns: 270
69+
```
70+
71+
72+
## Run tests
73+
74+
```sh
75+
npm run test
76+
```
77+
78+
79+
## Contact
80+
81+
82+
👤 **Timo Bechtel <timo@bechtel.solutions>**
83+
84+
- Website: https://timobechtel.com
85+
- Twitter: [@TimoBechtel](https://twitter.com/TimoBechtel)
86+
- GitHub: [@TimoBechtel](https://github.com/TimoBechtel)
87+
88+
## 🤝 Contributing
89+
90+
Contributions, issues and feature requests are welcome!<br />
91+
92+
1. Check [issues](https://github.com/CompactJS/limit/issues)
93+
1. Fork the Project
94+
1. Create your Feature Branch (`git checkout -b feat/AmazingFeature`)
95+
1. Test your changes `npm run test`
96+
1. Commit your Changes (`git commit -m 'feat: add amazingFeature'`)
97+
1. Push to the Branch (`git push origin feat/AmazingFeature`)
98+
1. Open a Pull Request
99+
100+
101+
102+
### Commit messages
103+
104+
This project uses semantic-release for automated release versions. So commits in this project follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) guidelines. I recommend using [commitizen](https://github.com/commitizen/cz-cli) for automated commit messages.
105+
106+
## Show your support
107+
108+
Give a ⭐️ if this project helped you!
109+
110+
## 📝 License
111+
112+
Distributed under the [MIT](https://github.com/CompactJS/limit/blob/master/LICENSE) License.
113+
114+
---
115+
116+
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

0 commit comments

Comments
 (0)