Merge pull request #2 from alevnyacow/feature/package-base

package base with github ci/cd

Author: alevnyacow

.eslintignore

@@ -0,0 +1,3 @@
+/node_modules/**
+/tests/**
+/transpiled/**

.eslintrc

@@ -0,0 +1,49 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "plugins": ["@typescript-eslint"],
+    "parserOptions": {
+        "ecmaVersion": 2017,
+        "sourceType": "module"
+    },
+    "rules": {
+        // ban debug stuff
+        "no-console": "error",
+        "no-debugger": "error",
+        // function writing rules
+        "max-params": ["error", 3],
+        "max-depth": ["error", 3],
+        "no-unreachable": "error",
+        "no-else-return": "error",
+        "no-var": "error",
+        "one-var": ["error", "never"],
+        "init-declarations": ["error", "always"],
+        // namings
+        "camelcase": "error",
+        "id-length": [
+            "error",
+            // "x" is for anonymous lambdas, "i" is for iterators in "for" loops
+            { "min": 3, "max": 40, "exceptions": ["x", "i", "id"] }
+        ],
+        // common code style
+        "curly": "error",
+        "prefer-const": "error",
+        "no-redeclare": "error",
+        "prefer-destructuring": [
+            "error",
+            { "object": true, "array": false },
+            { "enforceForRenamedProperties": false }
+        ],
+        "eqeqeq": "error",
+        "default-case": "error",
+        "no-magic-numbers": "off",
+        "@typescript-eslint/no-magic-numbers": ["error", { "ignoreArrayIndexes": true, "ignoreEnums": true, "ignore": [0, 1, -1] }],
+        "no-unused-expressions": "error",
+        "@typescript-eslint/no-unused-vars": "error",
+        "no-nested-ternary": "error",
+        "no-empty": "error",
+        "for-direction": "error",
+        "no-sparse-arrays": "error",
+        "yoda": "error"
+    }
+}

.github/workflows/npm-publish.yml

@@ -0,0 +1,34 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  run-tests-and-linter:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+      - run: npm i
+      - run: npm run check
+
+  publish-to-npm:
+    needs: run-tests-and-linter
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm i 
+      - run: npm run build
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+package-lock.json
+transpiled

.npmignore

@@ -0,0 +1,3 @@
+node_modules
+sources
+tests

.prettierrc

@@ -0,0 +1,11 @@
+{
+    "tabWidth": 4,
+    "trailingComma": "none",
+    "semi": true,
+    "printWidth": 80,
+    "singleQuote": false,
+    "arrowParens": "always",
+    "bracketSpacing": true,
+    "parser": "typescript",
+    "useTabs": false
+}

jest.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+    preset: 'ts-jest'
+}

package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@alevnyacow/shared-react-variables",
+  "version": "0.0.1",
+  "description": "Easy and comfortable React state manager",
+  "main": "transpiled/index.js",
+  "scripts": {
+    "test": "jest",
+    "clean_transpiled": "del-cli --force ./transpiled",
+    "format": "prettier --config .prettierrc --write sources/**",
+    "lint": "eslint sources/**/*.ts --ext .ts",
+    "check": "npm run lint && npm run test",
+    "build": "npm run clean_transpiled && tsc",
+    "execute": "npm run build && node transpiled/index.js"
+  },
+  "keywords": [
+    "react",
+    "state",
+    "state management",
+    "global state"
+  ],
+  "author": "alevnyacow",
+  "license": "MIT",
+  "devDependencies": {
+    "@testing-library/react": "^12.1.3",
+    "@types/jest": "^27.4.1",
+    "@types/react": "^17.0.39",
+    "@typescript-eslint/eslint-plugin": "^5.14.0",
+    "@typescript-eslint/parser": "^5.14.0",
+    "del-cli": "^4.0.1",
+    "eslint": "^8.10.0",
+    "jest": "^27.5.1",
+    "prettier": "^2.5.1",
+    "react": "^17.0.2",
+    "ts-jest": "^27.1.3",
+    "typescript": "^4.6.2"
+  },
+  "types": "transpiled/index.d.ts",
+  "dependencies": {
+    "@alevnyacow/deep-js-proxy": "^0.0.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alevnyacow/shared-react-variables.git"
+  },
+  "bugs": {
+    "url": "https://github.com/alevnyacow/shared-react-variables/issues"
+  },
+  "homepage": "https://github.com/alevnyacow/shared-react-variables#readme"
+}

sources/index.ts

@@ -0,0 +1,3 @@
+const answerForEverything = 42;
+
+export { answerForEverything };

tests/dummy.test.ts

@@ -0,0 +1,3 @@
+test("dummy_test", () => {
+	expect(1).toBe(1);
+});