Merge pull request #63 from hckrnews/feature/validation

Add the validator package

.eslintrc

@@ -0,0 +1,34 @@
+{
+    "root": true,
+    "env": {
+        "es6": true,
+        "node": true,
+        "browser": true
+    },
+    "globals": {
+        "describe": false,
+        "it": false,
+        "expect": false
+    },
+    "extends": [
+        "@hckrnews/eslint-config"
+    ],
+    "parserOptions": {
+        "sourceType": "module",
+        "parser": "babel-eslint",
+        "babelOptions": {
+            "configFile": "babel.config.js",
+        }
+    },
+    "overrides": [
+        {
+            "files": [
+                "**/__tests__/*.{j,t}s?(x)",
+                "**/tests/unit/**/*.spec.{j,t}s?(x)"
+            ],
+            "env": {
+                "jest": true
+            }
+        }
+    ]
+}

.github/workflows/npmpublish.yml

@@ -24,7 +24,7 @@ jobs:
         with:
           node-version: 12
           registry-url: https://registry.npmjs.org/
-      - run: npm ci
+      - run: npm ci --production
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.npm_token}}
@@ -39,7 +39,7 @@ jobs:
           node-version: 12
           registry-url: https://npm.pkg.github.com/
           scope: '@your-github-username'
-      - run: npm ci
+      - run: npm ci --production
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

README.md

@@ -20,7 +20,31 @@ or
 
 Example usage:
 ```javascript
-const flatter = new Obj({
+const addressSchema = {
+    street: String,
+    number: Number,
+    postalCode: String,
+    city: String,
+    country: String,
+};
+
+const Address = Obj({ schema: addressSchema })
+
+const myAddress = new Address({
+    street: 'Abc',
+    number: 42,
+    postalCode: '1234AB',
+    city: 'Example',
+    country: 'The Netherlands'
+})
+```
+
+Example usage without a schema:
+...
+
+```javascript
+const ObjectWithoutSchema = Obj()
+const flatter = new ObjectWithoutSchema({
     a: 1,
     b: 2,
     c: [3, 4],

babel.config.cjs

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

jest.config.js → jest.config.cjs

@@ -11,9 +11,7 @@ module.exports = {
         '^@/(.*)$': '<rootDir>/src/$1',
     },
 
-    testMatch: [
-        '**/tests/unit/**/*.spec.(js|jsx|ts|tsx)|**/__tests__/*.(js|jsx|ts|tsx)',
-    ],
+    testMatch: ['**/__tests__/*.js'],
 
     testURL: 'http://localhost/',