Skip to content

Commit

Permalink
Version 0.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
tshemsedinov committed Oct 23, 2021
0 parents commit 1e3f4de
Show file tree
Hide file tree
Showing 25 changed files with 2,256 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# http://editorconfig.org
root = true

[*]
end_of_line = lf
charset = utf-8
insert_final_newline = true
trim_trailing_whitespace = true

[{*.js,*.mjs,*.ts,*.json,*.yml}]
indent_size = 2
indent_style = space
3 changes: 3 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/
coverage/
dist
23 changes: 23 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"extends": "metarhia",
"env": {
"browser": true,
"es6": true,
"node": true
},
"parserOptions": {
"ecmaVersion": 2020
},
"rules": {
"arrow-parens": ["error", "always"],
"comma-dangle": "off",
"handle-callback-err": "off",
"consistent-return": "off",
"operator-linebreak": [
"error",
"after",
{ "overrides": { "?": "before", ":": "before" } }
],
"no-confusing-arrow": "off"
}
}
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* -text
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
patreon: tshemsedinov
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior: usage example or test.

**Expected behavior**
A clear and concise description of what you expected.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**

- OS: [e.g. Fedora 30 64-bit]
- Node.js version [e.g. 14.15.1]

**Additional context**
Add any other context about the problem here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Question
about: Please don't open an issue to ask questions
---

Issues on GitHub are intended to be related to problems and feature requests
so we recommend not using this medium to ask them here grin. Thanks for
understanding!

If you have a question, please check out our support groups and channels for
developers community:

Telegram:

- Channel for Metarhia community: https://t.me/metarhia
- Group for Metarhia technology stack community: https://t.me/metaserverless
- Group for NodeUA community: https://t.me/nodeua
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!--
Thank you for your pull request.
Check following steps to help us land your changes:
Change [ ] to [x] for completed items.
-->

- [ ] tests and linter show no problems (`npm t`)
- [ ] tests are added/updated for bug fixes and new features
- [ ] code is properly formatted (`npm run fmt`)
- [ ] description of changes is added in CHANGELOG.md
- [ ] update .d.ts typings
35 changes: 35 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Testing CI

on: pull_request

jobs:
build:
runs-on: ${{ matrix.os }}

strategy:
matrix:
node:
- 12
- 14
- 15
- 16
- 17
os:
- ubuntu-latest
- windows-latest
- macos-latest

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node }}
- uses: actions/cache@v2
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- run: npm ci
- run: npm test
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
*.log
.DS_Store
3 changes: 3 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
*.log
.DS_Store
10 changes: 10 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"singleQuote": true,
"trailingComma": "es5",
"overrides": [
{
"files": ["**/.*rc"],
"options": { "parser": "json" }
}
]
}
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Timur Shemsedinov <timur.shemsedinov@gmail.com>
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing

- [Issues](#issues)
- [Pull Requests](#pull-requests)

## Issues

There are two reasons to open an issue:

- Bug report
- Feature request

For bug reports please describe the bug with a clear and concise description,
steps to reproduce the behavior (usage example or test), expected behavior,
provide OS and Node.js version, you can upload screenshots and any additional
context for better understanding.

Please don't open an issue to ask questions.

Issues on GitHub are intended to be related to problems and feature requests
so we recommend not using this medium to ask them here grin. Thanks for
understanding!

If you have a question, please check out our support groups and channels for
developers community:

Telegram:

- Channel for Metarhia community: https://t.me/metarhia
- Group for Metarhia technology stack community: https://t.me/metaserverless
- Group for NodeUA community: https://t.me/nodeua

## Pull Requests

Before open pull request please follow checklist:

- [ ] tests and linter show no problems (`npm t`)
- [ ] tests are added/updated for bug fixes and new features
- [ ] code is properly formatted (`npm run fmt`)
- [ ] description of changes is added in CHANGELOG.md
- [ ] update .d.ts typings
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Metarhia contributors (full list in AUTHORS file)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Node Routine (noroutine)

[![ci status](https://github.com/metarhia/noroutine/workflows/Testing%20CI/badge.svg)](https://github.com/metarhia/noroutine/actions?query=workflow%3A%22Testing+CI%22+branch%3Amaster)
[![snyk](https://snyk.io/test/github/metarhia/noroutine/badge.svg)](https://snyk.io/test/github/metarhia/noroutine)
[![npm version](https://badge.fury.io/js/noroutine.svg)](https://badge.fury.io/js/noroutine)
[![npm downloads/month](https://img.shields.io/npm/dm/noroutine.svg)](https://www.npmjs.com/package/noroutine)
[![npm downloads](https://img.shields.io/npm/dt/noroutine.svg)](https://www.npmjs.com/package/noroutine)
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/metarhia/noroutine/blob/master/LICENSE)

## Usage

Install: `npm install noroutine`

```js
const noroutine = require('noroutine');

noroutine.init({
module: './module1.js',
pool: 5,
wait: 2000,
timeout: 5000,
});

(async () => {
const res = await norutine.method1({ key: 'value' });
console.log({ res });
})();
```

## License & Contributors

Copyright (c) 2017-2021 [Metarhia contributors](https://github.com/metarhia/noroutine/graphs/contributors).
Noroutine is [MIT licensed](./LICENSE).\
Noroutine is a part of [Metarhia](https://github.com/metarhia) technology stack.
16 changes: 16 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Security Policy

## Supported Versions

| Version | Supported |
| ------- | ------------------ |
| 0.x | :white_check_mark: |

## Reporting a Vulnerability

If you believe you have found a security vulnerability, let us know by sending
email to [timur.shemsedinov@gmail.com](mailto:timur.shemsedinov@gmail.com)
We will investigate that and do our best to quickly fix the problem.

Please don't open an issue to or discuss this security vulnerability in a public
place. Thanks for understanding!
3 changes: 3 additions & 0 deletions lib/pool.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
'use strict';

module.exports = {};
8 changes: 8 additions & 0 deletions noroutine.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
export interface NoroutineOptimons {
module: string;
pool: number;
wait: number;
timeout: number;
}

export function init(options: NoroutineOptimons): void;
7 changes: 7 additions & 0 deletions noroutine.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
'use strict';

const init = () => {
console.log('stub');
};

module.exports = { init };
Loading

0 comments on commit 1e3f4de

Please sign in to comment.