v3.0.1 refactor (#29)

* chore: update deps

* refactor(core): separate class responsibilities

BREAKING CHANGE
- refactor: use named exports
- refactor(Clickup): remove baseUrl and header helpers

* docs(README): remove broken shield

- docs(README): add yarn install option
- docs(README): fix type

* refactor(Request): consolidate request parameters into a general request function

- fix(createRequestInstance): remove double quotes around `prefixUrl`

- feat(Request): add helper functions

- refactor(Tasks): use request helper function to obtain the instance token

- chore(eslintrc): turn off `no-restricted-syntax`

- chore(ignores): add ignore file for `eslint` and update structure of `prettierignore`

* test: update to new project structure

* test: add new request util
* test: separate test types to their own respective files
* refactor(Request): rename `_service` to `_instance` for readability

* fix(Tasks): rename prefix from set to add to be inline with the rest of the package

* docs(*): implement docs using nuxt content

* chore(workflows): add pr test on pull requests

* docs(README): update docs link to new domain

* chore(workflows): increase node version to LTS
* 3.0.1

.eslintignore

@@ -0,0 +1,45 @@
+# ESLint
+# git
+.git
+.gitattributes
+.gitignore
+
+# vscode
+.vscode
+
+# docs
+docs/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test

.eslintrc.json

@@ -8,13 +8,13 @@
 	},
 	"extends": ["airbnb-base", "prettier"],
 	"plugins": ["prettier"],
-	"ignorePatterns": ["node_modules/**/*.js"],
 	"parserOptions": {
 		"ecmaVersion": 11
 	},
 	"rules": {
 		"prettier/prettier": "error",
 		"no-underscore-dangle": 0,
-		"no-param-reassign": "off"
+		"no-param-reassign": "off",
+		"no-restricted-syntax": "off"
 	}
 }

.github/workflows/npm-publish.yml

@@ -5,16 +5,16 @@ name: Node.js Package
 
 on:
   release:
-    types: [created]
+    types: [published]
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2
         with:
-          node-version: 12
+          node-version: 16
       - run: npm ci
       - run: npm test
 
@@ -23,9 +23,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2
         with:
-          node-version: 12
+          node-version: '16.x'
           registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: npm publish

.github/workflows/pr-test.yml

@@ -0,0 +1,20 @@
+name: PR Test
+on: [pull_request]
+jobs:
+  test-pr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v2
+
+      - name: Install Node v16
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Clean install deps
+        run: npm ci
+
+      - name: Run tests
+        run: npm test

.npmignore

@@ -1,13 +1,28 @@
 # NPM
+
+# node
 node_modules
+
+# git
 .git
+.gitattributes
+.gitignore
+
+# vscode
 .vscode
+
+# ESLint
 .eslintrc.json
-.jsdoc.json
+.eslintignore
+
+# prettier
 .prettierrc.json
-.gitattributes
-.gitignore
-npm-debug.log
+.prettierignore
+
+# project
+*.log
 test/
 docs/
+
+# github
 .github/

.prettierignore

@@ -1,11 +1,45 @@
 # Prettier
-node_modules
+# git
 .git
-.vscode
-.eslintrc.json
-.prettierrc.json
 .gitattributes
 .gitignore
-npm-debug.log
-test/
-docs/
+
+# vscode
+.vscode
+
+# docs
+docs/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test