chore: directory spring cleaning (readmeio#327)

* feat: dropping support for node 10

* test: fixing a broken test on node 14

* ci: updating the ci workflow to use node 12+

* ci: upgrading the codeql workflow to the latest way it configs

* chore(deps-dev): upgrading jest to v27

* chore(deps-dev): upgrading code styling dev deps

* chore(deps-dev): upgrading nock to the latest version

* chore: removing a swagger file that shouldnt be in the root dir?

* ci: updating codeql to run on `main` not `master`

* chore: updating the license to be 2021

* chore: renaming the test directory to `__tests__`

* chore: various dotfile cleanup

* chore: moving the codebase into a `src/` directory structure

.eslintignore

@@ -1 +1 @@
-coverage
+coverage/

.npmignore

@@ -1,9 +1,5 @@
-.DS_Store
-.editorconfig
-.eslintignore
-.eslintrc
+__tests__/
 .github/
-.prettierignore
-.prettierrc
 coverage/
-test/
+.eslint*
+.prettier*

.prettierignore

@@ -1 +1 @@
-coverage
+coverage/

LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2018 ReadMe.io
+Copyright © 2021 ReadMe
 
 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

test/cmds/docs.test.js → __tests__/cmds/docs.test.js

@@ -5,10 +5,10 @@ const path = require('path');
 const crypto = require('crypto');
 const frontMatter = require('gray-matter');
 
-const docs = require('../../cmds/docs/index');
-const docsEdit = require('../../cmds/docs/edit');
+const docs = require('../../src/cmds/docs');
+const docsEdit = require('../../src/cmds/docs/edit');
 
-const fixturesDir = `${__dirname}./../fixtures`;
+const fixturesDir = `${__dirname}./../__fixtures__`;
 const key = 'Xmw4bGctRVIQz7R7dQXqH9nQe5d0SPQs';
 const version = '1.0.0';
 
@@ -71,7 +71,7 @@ describe('rdme docs', () => {
         .basicAuth({ user: key })
         .reply(200);
 
-      return docs.run({ folder: './test/fixtures/existing-docs', key, version }).then(() => {
+      return docs.run({ folder: './__tests__/__fixtures__/existing-docs', key, version }).then(() => {
         getMock.done();
         putMock.done();
       });
@@ -94,7 +94,7 @@ describe('rdme docs', () => {
         .basicAuth({ user: key })
         .reply(200, { category: '5ae9ece93a685f47efb9a97c', slug, lastUpdatedHash: hash });
 
-      return docs.run({ folder: './test/fixtures/existing-docs', key, version }).then(([message]) => {
+      return docs.run({ folder: './__tests__/__fixtures__/existing-docs', key, version }).then(([message]) => {
         expect(message).toBe('`simple-doc` not updated. No changes.');
         getMock.done();
       });
@@ -133,7 +133,7 @@ describe('rdme docs', () => {
         .basicAuth({ user: key })
         .reply(201);
 
-      return docs.run({ folder: './test/fixtures/new-docs', key, version }).then(() => {
+      return docs.run({ folder: './__tests__/__fixtures__/new-docs', key, version }).then(() => {
         getMock.done();
         postMock.done();
       });

test/cmds/login.test.js → __tests__/cmds/login.test.js

@@ -1,7 +1,7 @@
 const nock = require('nock');
 const config = require('config');
-const configStore = require('../../lib/configstore');
-const cmd = require('../../cmds/login');
+const configStore = require('../../src/lib/configstore');
+const cmd = require('../../src/cmds/login');
 
 describe('rdme login', () => {
   beforeAll(() => nock.disableNetConnect());

test/cmds/logout.test.js → __tests__/cmds/logout.test.js

@@ -1,7 +1,7 @@
 const config = require('config');
-const configStore = require('../../lib/configstore');
-const cmd = require('../../cmds/logout');
-const loginCmd = require('../../cmds/login');
+const configStore = require('../../src/lib/configstore');
+const cmd = require('../../src/cmds/logout');
+const loginCmd = require('../../src/cmds/login');
 
 describe('rdme logout', () => {
   it("should report the user as logged out if they aren't logged in", () => {

test/cmds/open.test.js → __tests__/cmds/open.test.js

@@ -1,7 +1,7 @@
 const config = require('config');
-const configStore = require('../../lib/configstore');
-const cmd = require('../../cmds/open');
-const loginCmd = require('../../cmds/login');
+const configStore = require('../../src/lib/configstore');
+const cmd = require('../../src/cmds/open');
+const loginCmd = require('../../src/cmds/login');
 
 describe('rdme open', () => {
   it('should error if no project provided', () => {

test/cmds/swagger.test.js → __tests__/cmds/swagger.test.js

@@ -1,13 +1,13 @@
 const nock = require('nock');
 const config = require('config');
 const fs = require('fs');
-const promptHandler = require('../../lib/prompts');
-const swagger = require('../../cmds/swagger');
+const promptHandler = require('../../src/lib/prompts');
+const swagger = require('../../src/cmds/swagger');
 
 const key = 'Xmw4bGctRVIQz7R7dQXqH9nQe5d0SPQs';
 const version = '1.0.0';
 
-jest.mock('../../lib/prompts');
+jest.mock('../../src/lib/prompts');
 
 const getCommandOutput = () => {
   return [console.warn.mock.calls.join('\n\n'), console.log.mock.calls.join('\n\n')].filter(Boolean).join('\n\n');
@@ -51,7 +51,7 @@ describe('rdme swagger', () => {
     // Surface our test fixture to the root directory so rdme can autodiscover it. It's easier to do
     // this than mocking out the fs module because mocking the fs module here causes Jest sourcemaps
     // to break.
-    fs.copyFileSync('./test/fixtures/swagger.json', './swagger.json');
+    fs.copyFileSync('./__tests__/__fixtures__/swagger.json', './swagger.json');
 
     return swagger.run({ key }).then(() => {
       expect(console.log).toHaveBeenCalledTimes(2);
@@ -86,7 +86,7 @@ describe('rdme swagger', () => {
         help: 'If you need help, email [email protected] and mention log "fake-metrics-uuid".',
       });
 
-    return expect(swagger.run({ spec: './test/fixtures/swagger.json', key, version }))
+    return expect(swagger.run({ spec: './__tests__/__fixtures__/swagger.json', key, version }))
       .rejects.toThrow('The version you specified')
       .then(() => mock.done());
   });
@@ -103,7 +103,7 @@ describe('rdme swagger', () => {
       .basicAuth({ user: key })
       .reply(201, { _id: 1 }, { location: exampleRefLocation });
 
-    return swagger.run({ spec: './test/fixtures/swagger.json', key, version }).then(() => {
+    return swagger.run({ spec: './__tests__/__fixtures__/swagger.json', key, version }).then(() => {
       expect(console.log).toHaveBeenCalledTimes(1);
 
       const output = getCommandOutput();
@@ -134,7 +134,7 @@ describe('rdme swagger', () => {
         help: 'If you need help, email [email protected] and mention log "fake-metrics-uuid".',
       });
 
-    return expect(swagger.run({ spec: './test/fixtures/invalid-swagger.json', key, version }))
+    return expect(swagger.run({ spec: './__tests__/__fixtures__/invalid-swagger.json', key, version }))
       .rejects.toThrow('README VALIDATION ERROR "x-samples-languages" must be of type "Array"')
       .then(() => mock.done());
   });
@@ -161,7 +161,7 @@ describe('rdme swagger', () => {
       .basicAuth({ user: key })
       .reply(201, { _id: 1 }, { location: exampleRefLocation });
 
-    return swagger.run({ spec: './test/fixtures/swagger.json', key }).then(() => {
+    return swagger.run({ spec: './__tests__/__fixtures__/swagger.json', key }).then(() => {
       mock.done();
     });
   });
@@ -174,7 +174,7 @@ describe('rdme swagger', () => {
       .basicAuth({ user: key })
       .reply(201, { body: '{ id: 1 }' });
 
-    return swagger.run({ spec: './test/fixtures/swagger.json', key, id, version }).then(() => {
+    return swagger.run({ spec: './__tests__/__fixtures__/swagger.json', key, id, version }).then(() => {
       mock.done();
     });
   });
@@ -187,7 +187,7 @@ describe('rdme swagger', () => {
       .basicAuth({ user: key })
       .reply(201, { id: 1 }, { location: exampleRefLocation });
 
-    return swagger.run({ spec: './test/fixtures/swagger.json', token: `${key}-${id}`, version }).then(() => {
+    return swagger.run({ spec: './__tests__/__fixtures__/swagger.json', token: `${key}-${id}`, version }).then(() => {
       expect(console.warn).toHaveBeenCalledTimes(1);
       expect(console.log).toHaveBeenCalledTimes(1);
 
@@ -200,7 +200,7 @@ describe('rdme swagger', () => {
   });
 
   it('should error if no api key provided', async () => {
-    await expect(swagger.run({ spec: './test/fixtures/swagger.json' })).rejects.toThrow(
+    await expect(swagger.run({ spec: './__tests__/__fixtures__/swagger.json' })).rejects.toThrow(
       'No project API key provided. Please use `--key`.'
     );
   });

test/cmds/versions.test.js → __tests__/cmds/versions.test.js

@@ -1,11 +1,11 @@
 const nock = require('nock');
 const config = require('config');
-const promptHandler = require('../../lib/prompts');
+const promptHandler = require('../../src/lib/prompts');
 
-const versions = require('../../cmds/versions/index');
-const createVersion = require('../../cmds/versions/create');
-const deleteVersion = require('../../cmds/versions/delete');
-const updateVersion = require('../../cmds/versions/update');
+const versions = require('../../src/cmds/versions');
+const createVersion = require('../../src/cmds/versions/create');
+const deleteVersion = require('../../src/cmds/versions/delete');
+const updateVersion = require('../../src/cmds/versions/update');
 
 const key = 'Xmw4bGctRVIQz7R7dQXqH9nQe5d0SPQs';
 const version = '1.0.0';
@@ -31,7 +31,7 @@ const version2Payload = {
   version: version2,
 };
 
-jest.mock('../../lib/prompts');
+jest.mock('../../src/lib/prompts');
 
 describe('rdme versions*', () => {
   beforeAll(() => nock.disableNetConnect());

test/cmds/whoami.test.js → __tests__/cmds/whoami.test.js

@@ -1,7 +1,7 @@
 const config = require('config');
-const configStore = require('../../lib/configstore');
-const cmd = require('../../cmds/whoami');
-const loginCmd = require('../../cmds/login');
+const configStore = require('../../src/lib/configstore');
+const cmd = require('../../src/cmds/whoami');
+const loginCmd = require('../../src/cmds/login');
 
 describe('rdme whoami', () => {
   it('should error if user is not authenticated', () => {

test/cli.test.js → __tests__/index.test.js

@@ -1,10 +1,10 @@
 require('colors');
 
 const nock = require('nock');
-const cli = require('../cli');
+const cli = require('../src');
 const { version } = require('../package.json');
-const conf = require('../lib/configstore');
-const swaggerCmd = require('../cmds/swagger');
+const conf = require('../src/lib/configstore');
+const swaggerCmd = require('../src/cmds/swagger');
 
 describe('cli', () => {
   it('command not found', () => {

test/lib/apiError.test.js → __tests__/lib/apiError.test.js

@@ -1,4 +1,4 @@
-const APIError = require('../../lib/apiError');
+const APIError = require('../../src/lib/apiError');
 
 const response = {
   error: 'VERSION_FORK_EMPTY',

test/lib/commands.test.js → __tests__/lib/commands.test.js

@@ -1,14 +1,14 @@
-const commands = require('../../lib/commands').list();
+const commands = require('../../src/lib/commands');
 
 describe('utils', () => {
-  describe('#getCommands', () => {
+  describe('#list', () => {
     it('should have commands returned', () => {
-      expect(commands).not.toHaveLength(0);
+      expect(commands.list()).not.toHaveLength(0);
     });
 
     describe('commands', () => {
       it('should be configured properly', () => {
-        commands.forEach(c => {
+        commands.list().forEach(c => {
           const cmd = c.command;
 
           expect(typeof cmd.command === 'string' && cmd.command.length !== 0).toBe(true);
@@ -31,7 +31,7 @@ describe('utils', () => {
       });
 
       it('should abide by our cli standards', () => {
-        commands.forEach(c => {
+        commands.list().forEach(c => {
           const cmd = c.command;
 
           expect(cmd.description[cmd.description.length - 1]).toBe('.');

test/lib/prompts.test.js → __tests__/lib/prompts.test.js

@@ -1,5 +1,5 @@
 const Enquirer = require('enquirer');
-const promptHandler = require('../../lib/prompts');
+const promptHandler = require('../../src/lib/prompts');
 
 const versionlist = [
   {

rdme.js → bin/rdme

@@ -1,7 +1,7 @@
 #! /usr/bin/env node
 require('colors');
 
-require('./cli')(process.argv.slice(2))
+require('../src')(process.argv.slice(2))
   .then(msg => {
     if (msg) console.log(msg);
     process.exit(0);

package.json

@@ -7,7 +7,7 @@
     "node": "^12 || ^14 || ^16"
   },
   "bin": {
-    "rdme": "rdme.js"
+    "rdme": "bin/rdme"
   },
   "tags": [
     "api",
@@ -63,17 +63,20 @@
     "test": "jest --coverage"
   },
   "jest": {
-    "setupFiles": [
-      "./test/set-node-env"
-    ],
     "coverageThreshold": {
       "global": {
         "branches": 80,
         "functions": 80,
         "lines": 90,
         "statements": 90
       }
-    }
+    },
+    "setupFiles": [
+      "./__tests__/set-node-env"
+    ],
+    "testPathIgnorePatterns": [
+      "./__tests__/set-node-env"
+    ]
   },
   "prettier": "@readme/eslint-config/prettier"
 }

cmds/oas.js → src/cmds/oas.js

@@ -10,7 +10,7 @@ exports.position = 1;
 exports.args = [];
 
 exports.run = function () {
-  const cp = spawn(path.join(__dirname, '..', 'node_modules', '.bin', 'oas'), process.argv.slice(3), {
+  const cp = spawn(path.join(__dirname, '..', '..', 'node_modules', '.bin', 'oas'), process.argv.slice(3), {
     stdio: 'inherit',
   });
 

cli.js → src/index.js

@@ -9,13 +9,13 @@ const path = require('path');
 // but since this is only supposed to be a cli and not
 // requireable, i think this is okay
 const configDir = process.env.NODE_CONFIG_DIR;
-process.env.NODE_CONFIG_DIR = path.join(__dirname, '/config');
+process.env.NODE_CONFIG_DIR = path.join(__dirname, '../config');
 
 const config = require('config');
 
 process.env.NODE_CONFIG_DIR = configDir;
 
-const { version } = require('./package.json');
+const { version } = require('../package.json');
 const configStore = require('./lib/configstore');
 const help = require('./lib/help');
 const commands = require('./lib/commands');

lib/configstore.js → src/lib/configstore.js

@@ -1,4 +1,4 @@
 const Configstore = require('configstore');
-const pkg = require('../package.json');
+const pkg = require('../../package.json');
 
 module.exports = new Configstore(`${pkg.name}-${process.env.NODE_ENV || 'production'}`);