Merge pull request #14 from bcgsc/release/v2.0.0

Release/v2.0.0

.eslintrc.json

@@ -5,22 +5,23 @@
         "node": true
     },
     "extends": [
-        "eslint:recommended",
-        "airbnb",
+        "plugin:jest-formatting/recommended",
         "plugin:jest/recommended",
-        "plugin:jest-formatting/recommended"
+        "airbnb-base",
+        "airbnb-typescript/base",
+        "plugin:@typescript-eslint/recommended"
     ],
+    "parserOptions": {
+        "project": "./tsconfig.eslint.json"
+    },
     "plugins": [
         "jest",
         "jest-formatting"
     ],
     "rules": {
-        "indent": [
+        "@typescript-eslint/indent": [
             "error",
-            4,
-            {
-                "SwitchCase": 1
-            }
+            4
         ],
         "jest/consistent-test-it": [
             "error",
@@ -32,7 +33,17 @@
             "error",
             "unix"
         ],
-        "max-len": "warn",
+        "max-classes-per-file": "off",
+        "max-len": [
+            "warn",
+            {
+                "code": 100,
+                "ignoreComments": true,
+                "ignoreStrings": true,
+                "ignoreTemplateLiterals": true,
+                "ignoreTrailingComments": true
+            }
+        ],
         "multiline-ternary": [
             "error",
             "always"

.github/workflows/npm-test.yml

@@ -16,6 +16,9 @@ jobs:
           node-version: ${{ matrix.node }}
       - run: npm ci
       - run: npm audit --production
+      - run: npm run lint
+      - name: test build
+        run: npm run build
       - run: npm test
       - name: Publish Unit Test Results
         uses: EnricoMi/publish-unit-test-result-action@v1.6

.gitignore

@@ -5,4 +5,5 @@ node_modules/
 xunit.xml
 jsdoc
 *tar.gz
-env.sh
+env.sh
+dist

README.md

@@ -17,34 +17,37 @@ parsed notation.
 Import the package (Or try it out online with [RunKit](https://runkit.com/creisle/6083062ff39ff0001b93ea6f))
 
 ```js
-const kbp = require('@bcgsc-pori/graphkb-parser');
+const {parseVariant, stringifyVariant, jsonifyVariant} = require('@bcgsc-pori/graphkb-parser');
 ```
 
 To use the variant parser methods simply pass a string into
 
 ```js
-> const parsedResult = kbp.variant.parse('FEATURE:p.G12D');
-VariantNotation(....)
+> const parsedResult = parseVariant('FEATURE:p.G12D');
+{
+    'prefix': 'p',
+    ...
+}
 ```
 
 Which returns a variant notation object. This can be turned back into a string
 
 ```js
-> parsedResult.toString();
+> stringifyVariant(parsedResult);
 'FEATURE:p.G12D'
 ```
 
-or a JSON
+or a JSON (removes extra attributes used by parse methods)
 
 ```js
-> parsedResult.toJSON()
+> jsonifyVariant(parsedResult)
 ```
 
 If the notation is improperly formatted, the parse function will raise a parsing error
 
 ```js
 try {
-   const parsedResult = kbp.variant.parse('FEATUREp.G12D');
+   const parsedResult = parseVariant('FEATUREp.G12D');
 } catch (err) {
     if (err instanceof kbp.error.ParsingError) {
         console.log('Error in parsing the notation');

babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+    presets: [
+        ['@babel/preset-env', { targets: { node: 'current' } }],
+        '@babel/preset-typescript',
+    ],
+};

config/jest.config.js

@@ -8,9 +8,9 @@ module.exports = {
     collectCoverage: true,
     coverageDirectory: 'coverage',
     collectCoverageFrom: [
-        'src/**.js',
-        'src/**/*.js',
-        'src/**/**/*.js',
+        'src/*',
+        'src/**/*',
+        'src/**/**/*',
     ],
     coverageReporters: [
         'clover',
@@ -29,13 +29,14 @@ module.exports = {
         ],
     ],
     testRunner: 'jest-circus/runner',
-    testRegex: 'test/.*\\.js',
+    testRegex: 'test/.*',
     testEnvironment: 'node',
     testPathIgnorePatterns: [
         '/node_modules/',
     ],
     moduleFileExtensions: [
         'js',
         'json',
+        'ts',
     ],
 };