Fix: Add linting, GitHub Actions, package meta

.eslintrc.js

@@ -1,28 +1,39 @@
 module.exports = {
+	"globals": {
+		"$shouldNotMutate": "readonly",
+	},
 	"plugins": [
 		"evelyn",
 	],
 	"extends": [
 		"plugin:evelyn/default",
-		"plugin:evelyn/source",
 		"plugin:evelyn/node",
+		"plugin:evelyn/source",
 	],
 	"overrides": [
 		{
-			"files": [
-				"lib/**/*.js",
-			],
-			"extends": [
-				"plugin:evelyn/built",
-			],
 			"files": [
 				"**/*.test.js",
 				"**/__mocks__/**/*.js",
 				"**/__tests__/**/*.js",
+				"config/setup-after-env.js",
 			],
 			"extends": [
 				"plugin:evelyn/jest",
 			],
 		},
+		{
+			"files": [
+				"**/__fixtures__/**/*.js",
+			],
+			"rules": {
+				"no-unused-vars": "off",
+			},
+		},
+	],
+	"ignorePatterns": [
+		"src/foo.js",
+		"notes.js",
+		"**/__fixtures__/**/output.js",
 	],
 };

.github/workflows/nodejs.yml

@@ -0,0 +1,35 @@
+name: testing
+
+on: push
+
+jobs:
+  testing:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js 10.x
+      uses: actions/setup-node@v1
+      with:
+        node-version: 10.x
+
+    # From: https://help.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows#example-using-the-cache-action
+    - name: Cache node modules
+      uses: actions/cache@v1
+      env:
+        cache-name: cache-node-modules
+      with:
+        path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+          ${{ runner.os }}-build-
+          ${{ runner.os }}-
+
+    - name: Install Dependencies
+      run: npm ci
+    - name: Lint
+      run: npm run lint
+    - name: Test
+      run: npm test

README.md

@@ -0,0 +1,33 @@
+<div align="center">
+
+# Will Mutate
+
+**Runtime test to that detects mutations to objects**
+
+[![npm version](https://badgen.net/npm/v/will-mutate?icon=npm)](https://www.npmjs.com/package/will-mutate)
+[![check status](https://badgen.net/github/checks/evelynhathaway/will-mutate/master?icon=github)](https://github.com/evelynhathaway/will-mutate/actions)
+[![license: MIT](https://badgen.net/badge/license/MIT/blue)](/LICENSE)
+
+</div>
+
+## Description
+
+TODO
+
+## Features
+
+- TODO
+
+## Installation
+
+```bash
+npm install will-mutate @babel/core@^7.0.0 --save-dev
+```
+
+## Usage
+
+TODO
+
+## License
+
+Copyright Evelyn Hathaway and Corbin Crutchley, [MIT License](/LICENSE)

babel.config.js

@@ -1,10 +1,10 @@
 // babel.config.js
 module.exports = {
-  presets: [
-    [
-      '@babel/preset-env',
-      {targets: {node: 'current'}}
-    ]
-  ],
-  plugins: ['./plugin']
+	presets: [
+		[
+			"@babel/preset-env",
+			{targets: {node: "current"}},
+		],
+	],
+	plugins: ["./plugin"],
 };

config/setup-after-env.js

@@ -0,0 +1,3 @@
+import {toMatchFile} from "jest-file-snapshot";
+
+expect.extend({toMatchFile});