Merge pull request #6 from julyskies/develop

2.0.0

Author: peterdee

.DS_Store

@@ -1,25 +1,47 @@
 {
   "env": {
-    "commonjs": true,
     "es2021": true,
+    "jest": true,
     "node": true
   },
-  "extends": [
-    "airbnb-base"
+  "extends": ["airbnb-base"],
+  "ignorePatterns": [
+    "build",
+    "runtime.js",
+    "src/tests"
   ],
+  "parser": "@typescript-eslint/parser",
   "parserOptions": {
-    "ecmaVersion": 12
+    "ecmaVersion": 13,
+    "sourceType": "module"
   },
-  "ignorePatterns": [
-    "tests/*.js",
-    "runtime.js"
+  "plugins": [
+    "@typescript-eslint"
   ],
   "rules": {
+    "@typescript-eslint/no-unused-vars": ["error"],
+    "@typescript-eslint/no-use-before-define": ["error"],
+    "import/extensions": [
+      "error",
+      "ignorePackages",
+      {
+        "ts": "never"
+      }
+    ],
     "max-len": [
       "error",
       {
         "code": 100
       }
-    ]
+    ],
+    "no-unused-vars": "off",
+    "no-use-before-define": "off"
+  },
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "extensions": [".ts"]
+      }
+    }
   }
 }

.eslintrc.json

@@ -0,0 +1,19 @@
+
+   
+name: Publish Scryptwrap to NPM
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    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 ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/publish.yml

@@ -1,8 +1,11 @@
+# Build
+build/
+
 # Dependencies
 node_modules/
 
 # NPM
 .npmrc
 
 # Misc
-runtime.js
+.env

.gitignore

@@ -1,6 +1,11 @@
+# Directories
+.github/
+build/tests/
+src/
+
+# Files
+.env
 .eslintrc.json
-.gitignore
 .travis.yml
 package-lock.json
-runtime.js
-/tests
+tsconfig.json

.npmignore

@@ -1,4 +1,4 @@
 language: node_js
 node_js:
-  - 14
+  - 16
 script: npm run test

.travis.yml

@@ -1,5 +1,4 @@
-  
-Copyright 2021, Peter Dyumin
+Copyright 2022, Peter Dyumin
 
 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:
 

LICENSE LICENSE.mdLICENSE renamed to LICENSE.md

@@ -19,7 +19,7 @@ npm i scryptwrap
 Load the module:
 
 ```javascript
-const { compare, hash } = require('scryptwrap');
+import { compare, hash } from 'scryptwrap';
 ```
 
 Create a hash:
@@ -39,6 +39,17 @@ if (isValid) {
 
 ### Testing
 
+Deploy the project locally:
+
+```shell script
+git clone https://github.com/julyskies/scryptwrap
+cd ./scryptwrap
+nvm use 16
+npm i
+```
+
+Run tests:
+
 ```shell script
 npm run test
 ```
@@ -47,10 +58,14 @@ Tests are done with [Jest](https://jestjs.io)
 
 ### Linting
 
+After deploying the project and installing the modules you can do the linting:
+
 ```shell script
 npm run lint
 ```
 
+Using [ESLint](https://www.npmjs.com/package/eslint)
+
 ### License
 
-[MIT](./LICENSE)
+[MIT](./LICENSE.md)