feat(test): exposed the test function

.eslintrc.yml

@@ -1,3 +1,8 @@
 extends:
   - '@form8ion'
-  - '@form8ion/mocha'
+  - '@form8ion/mocha'
+
+overrides:
+  - files: example.js
+    rules:
+      import/no-extraneous-dependencies: off

README.md

@@ -36,10 +36,18 @@ $ npm install @form8ion/lift-javascript --save-prod
 
 ### Example
 
+#### Import
+
 ```javascript
-import {lift} from '@form8ion/lift-javascript';
+import {lift, test} from '@form8ion/lift-javascript';
+```
 
-lift({results: {dependencies: [], devDependencies: [], scripts: {}, elintConfigs: []}});
+#### Execute
+
+```javascript
+if (test({projectRoot: process.cwd()})) {
+  lift({results: {dependencies: [], devDependencies: [], scripts: {}, elintConfigs: []}});
+}
 ```
 
 ## Contributing

example.js

@@ -1,3 +1,15 @@
-import {lift} from './lib/index.cjs';
+// #### Import
+// remark-usage-ignore-next
+import stubbedFs from 'mock-fs';
+import {lift, test} from './lib/index.cjs';
 
-lift({results: {dependencies: [], devDependencies: [], scripts: {}, elintConfigs: []}});
+// remark-usage-ignore-next
+stubbedFs();
+
+// #### Execute
+
+if (test({projectRoot: process.cwd()})) {
+  lift({results: {dependencies: [], devDependencies: [], scripts: {}, elintConfigs: []}});
+}
+// remark-usage-ignore-next
+stubbedFs.restore();

package.json

@@ -53,6 +53,7 @@
     "husky": "4.2.5",
     "lockfile-lint": "4.2.2",
     "mocha": "7.1.1",
+    "mock-fs": "^4.12.0",
     "npm-run-all": "4.1.5",
     "nyc": "15.0.1",
     "remark-cli": "8.0.0",

src/index.js

@@ -1 +1,2 @@
 export {default as lift} from './lift';
+export {default as test} from './test';

src/test-test.js

@@ -0,0 +1,11 @@
+import testApplicability from './test';
+
+suite('applicability test', () => {
+  test('that `true` is returned if the project has an `.nvmrc` file', async () => {
+    await testApplicability();
+  });
+
+  test('that `false` is returned if the project does not have an `.nvmrc` file', async () => {
+
+  });
+});

src/test.js

@@ -0,0 +1,3 @@
+export default function () {
+
+}