Skip to content

Commit

Permalink
feat(chowly-client): add initial chowly integration
Browse files Browse the repository at this point in the history
  • Loading branch information
Panevschi Ruslan authored and ruscon committed May 18, 2020
1 parent 0ae190f commit 26433c0
Show file tree
Hide file tree
Showing 41 changed files with 1,142 additions and 1 deletion.
8 changes: 8 additions & 0 deletions .commitlintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module.exports = {
extends: ['@commitlint/config-conventional'],
scopes: [{ name: 'client' }, { name: 'tutorial' }],
scopeOverrides: {
fix: [{ name: 'style' }, { name: 'unit' }, { name: 'e2e' }, { name: 'integration' }],
},
allowCustomScopes: true,
};
99 changes: 99 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
/**
* How to install and use
* @link {https://www.arden.nl/setting-up-a-gatsby-js-starter-with-type-script-es-lint-prettier-and-pre-commit-hooks}
*
* Rule documentation
* @link {https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-var-requires.md}
*/
module.exports = {
root: true,
env: {
browser: true,
node: true,
es6: true,
mocha: true,
},
ignorePatterns: ['bin/prepublish.js', 'jest.config.js'],
parser: '@typescript-eslint/parser',
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:@typescript-eslint/recommended-requiring-type-checking',
'plugin:prettier/recommended',
'plugin:import/errors',
'plugin:import/warnings',
'plugin:import/typescript',
'prettier',
'prettier/@typescript-eslint',
],
settings: {
'import/parsers': {
'@typescript-eslint/parser': ['.ts', '.tsx'],
},
},
parserOptions: {
project: './tsconfig.eslint.json',
},
plugins: ['@typescript-eslint', 'import', 'prettier'],
rules: {
'prettier/prettier': 'error',
'import/no-deprecated': ['error'],
'import/order': ['error', { groups: ['builtin', 'external', 'parent', 'sibling', 'index'] }],
'@typescript-eslint/explicit-member-accessibility': ['error', { accessibility: 'no-public' }],
'@typescript-eslint/explicit-function-return-type': ['error'],
'@typescript-eslint/interface-name-prefix': 'off',
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-inferrable-types': 'off',
'@typescript-eslint/no-non-null-assertion': 'off',
'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
'@typescript-eslint/no-empty-interface': 'off',
'@typescript-eslint/no-require-imports': ['error'],
'@typescript-eslint/no-use-before-define': ['error'],
'@typescript-eslint/camelcase': 'off',
'@typescript-eslint/ban-ts-ignore': 'off',
'@typescript-eslint/unbound-method': 'off',
'@typescript-eslint/require-await': 'off',
'@typescript-eslint/promise-function-async': [
'error',
{
allowAny: true,
},
],
'@typescript-eslint/ban-types': [
'error',
{
types: {
Number: {
message: 'Use number instead',
fixWith: 'number',
},
Function: {
message: 'Use () => void instead',
fixWith: '() => void',
},
Object: {
message: 'Use object instead',
fixWith: 'object',
},
String: {
message: 'Use string instead',
fixWith: 'string',
},
},
},
],
},
overrides: [
{
files: ['**/*.spec.js', '**/*.spec.jsx', '**/*.spec.ts'],
rules: {
'@typescript-eslint/no-require-imports': 'off',
'@typescript-eslint/no-var-requires': 'off',
'@typescript-eslint/explicit-function-return-type': 'off',
},
"env": {
"jest": true
}
},
],
};
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: Bug Report

about: Report a reproducible bug

title: ''

labels: ''

assignees: ''

---

<!-- Click "Preview" for a more readable version --
Please read and follow the instructions before submitting an issue:
- Read all our documentation, especially the [README](https://github.com/goparrot/chowly-api-client/blob/master/README.md). It may contain information that helps you solve your issue.
- Ensure your issue isn't already [reported](https://github.com/goparrot/chowly-api-client/issues).
- If you aren't sure that the issue is caused by Chowly Api Client or you just need help, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/goparrot-chowly-api-client).
- Ensure it isn't already fixed in the latest Chowly Api Client version.
⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️
-->

## Describe the bug

<!-- A clear and concise description of what the bug is. If your problem is not a bug, please file under Question -->

## To Reproduce

<!-- Code snippet to reproduce, ideally that will work by pasting into something like <https://npm.runkit.com/goparrot/chowly-api-client>, a hosted solution, or a repository that illustrates the issue. **If your problem is not reproducible, please file under Question** -->

```typescript
// Example code here
```

## Expected behavior

<!-- A clear and concise description of what you expected to happen. -->

## Environment:

* Chowly Api Client Version: x.y.z
* Node version: x.y.z

## Additional context/Screenshots

<!-- Add any other context about the problem here. If applicable, add screenshots to help explain. -->
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: ✨ Feature Request

about: Suggest an idea or feature

title: 'feat: '

labels: feature

assignees: KanoniPan

---

## Issue Number: [N/A]

## Does this PR introduce a breaking change

[ ] Yes
[ ] No

<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->

## Is your feature request related to a problem? Please describe.

<!-- Please describe the problem you are trying to solve. -->

## Describe the solution you'd like

<!-- Please describe the desired behavior. -->

## Describe alternatives you've considered

<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->

## Additional context

<!-- Add any other context or screenshots about the feature request here. -->
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/3-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: 📚 Documentation

about: Found a typo or something that isn't crystal clear in our docs?

title: 'docs: '

labels: documentation

assignees: KanoniPan

---

<!-- Click "Preview" for a more readable version --
If you found an area that needs clarification, feel free to open a PR or list the section/content that could be improved below
⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️
-->

## Section/Content To Improve

<!-- Quote or link to section -->

## Suggested Improvement

<!-- Identify what is confusing or incorrect and what could make it better -->

## Relevant File(s):

<!-- [e.g. README.md] -->
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/4-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: Question

about: Get help using Chowly Api Client

title: 'question: '

labels: question

assignees: ''

---

<!-- Click "Preview" for a more readable version --
Please read and follow the instructions before submitting an issue:
- Read all our documentation, especially the [README](https://github.com/goparrot/chowly-api-client/blob/master/README.md). It may contain information that helps you solve your issue.
- Ensure your issue isn't already [reported](https://github.com/goparrot/chowly-api-client/issues).
- If you aren't sure that the issue is caused by Chowly Api Client or you just need help, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/goparrot-chowly-api-client).
⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️
-->

## Environment:

* Chowly Api Client Version: x.y.z
* Node version: x.y.z

## Describe the issue

<!-- A clear and concise description of what the issue is. -->

## Example Code

<!-- Code snippet to illustrate your question. -->

```typescript
// Example code here
```

## Expected behavior, if applicable

<!-- A clear and concise description of what you expected to happen. -->

## Additional context/screenshots

<!-- Add any other context about the problem here. If applicable, add screenshots to help explain. -->
47 changes: 47 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<!--
Thanks for creating a Pull Request! Before you submit, please make sure
you've done the following:
- I read the contributing document at https://github.com/goparrot/chowly-api-client/blob/master/CONTRIBUTING.md#contributing
-->

<!--
Make our lives easier! Choose one of the following by uncommenting it:
-->

<!-- This is a 🐛 bug fix. -->

<!-- This is a 🙋 feature or enhancement. -->

<!-- This is a 🔦 documentation change. -->

<!--
Before you submit this pull request, make sure to have a look at the following
checklist. If you don't know how to do some of these, that's fine! Submit
your pull request and we will help you out on the way.
- I've added tests (if it's a bug, feature or enhancement)
- I've adjusted the documentation (if it's a feature or enhancement)
- The test suite passes locally (run `npm test` to verify this)
-->

## Summary

<!--
Provide a description of what your pull request changes.
-->

## Context

<!--
Is this related to any GitHub issue(s)?
You can use keywords to automatically close the related issue.
For example, (all of) the following will close issue #4567 when your PR is merged.
Closes #4567
Fixes #4567
Resolves #4567
Use any one of the above as applicable.
-->
15 changes: 15 additions & 0 deletions .github/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
updateDocsComment: >
Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would update some of our documentation based on your changes.
updateDocsWhiteList:
- bug
- fix
- Backport
- dev
- Update
- WIP
- chore

updateDocsTargetFiles:
- README
- docs/
Loading

0 comments on commit 26433c0

Please sign in to comment.