@fullstacksjs/eslint-config 7.1.0 → 7.2.0

package/bin/index.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+const createOptions = require('./lib/createOptions');
+const createTasks = require('./lib/tasks');
+
+createOptions()
+  .then(createTasks)
+  .then(tasks => tasks.run())
+  .catch(() => {});

package/bin/lib/createOptions.js

@@ -0,0 +1,25 @@
+const getUserInput = require('./getUserInput');
+const args = require('./parseArgs');
+
+const eslintrcConfig = {
+  extends: ['@fullstacksjs'],
+};
+
+const requiredPackages = ['@fullstacksjs/eslint-config', 'eslint', 'prettier'];
+
+async function createOptions() {
+  const isTechnologyInArgv = args.t != null;
+  const optionsFromArgs = { technology: args.t };
+  const userInput = isTechnologyInArgv ? optionsFromArgs : await getUserInput();
+
+  if (userInput.language === 'ts') {
+    requiredPackages.push('typescript');
+  }
+
+  return {
+    eslintrc: eslintrcConfig,
+    packages: requiredPackages,
+  };
+}
+
+module.exports = createOptions;

package/bin/lib/generateFile.js

@@ -0,0 +1,15 @@
+const { writeFile } = require('fs/promises');
+
+function createFileTask(eslintrc, ctx, task) {
+  return writeFile('.eslintrc', JSON.stringify(eslintrc, null, 2))
+    .then(() => {
+      task.title = `.eslintrc - Successfully Generated.`;
+    })
+    .catch(() => {
+      ctx.isEslintrc = false;
+      task.title = `Generating .eslintrc file`;
+      throw Error("Couldn't create file");
+    });
+}
+
+module.exports = createFileTask;

package/bin/lib/getUserInput.js

@@ -0,0 +1,24 @@
+const inquirer = require('inquirer');
+
+function getUserInput() {
+  return inquirer.prompt([
+    {
+      type: 'list',
+      name: 'language',
+      message: 'which technology are you using?',
+      choices: [
+        {
+          value: 'ts',
+          name: 'ESLint alongside TypeScript',
+        },
+        {
+          value: 'js',
+          name: 'ESLint for JavaScript development',
+        },
+      ],
+      default: 'js',
+    },
+  ]);
+}
+
+module.exports = getUserInput;

package/bin/lib/parseArgs.js

@@ -0,0 +1,12 @@
+const yargs = require('yargs');
+
+const args = yargs(process.argv.slice(2))
+  .alias('t', 'technology')
+  .describe('t', 'Which technology are you using')
+  .choices('t', ['ts', 'js'])
+  .usage('Usage: $0 [-t ts|js]')
+  .example('$0 - ts')
+  .help('h')
+  .alias('h', 'help').argv;
+
+module.exports = args;

package/bin/lib/tasks.js

@@ -0,0 +1,27 @@
+const Listr = require('listr');
+const util = require('util');
+const exec = util.promisify(require('child_process').exec);
+const createFileTask = require('./generateFile');
+
+function createTasks({ packages, eslintrc }) {
+  const installTasks = packages.map(pkg => ({
+    title: `Installing ${pkg}`,
+    task: (ctx, task) => exec(`npm i -D ${pkg}`).then(() => (task.title = `${pkg} Installed`)),
+  }));
+
+  return new Listr(
+    [
+      {
+        title: 'Installing dependencies using npm',
+        task: () => new Listr(installTasks, { exitOnError: true }),
+      },
+      {
+        title: 'Generating .eslintrc file',
+        task: (ctx, task) => createFileTask(eslintrc, ctx, task),
+      },
+    ],
+    { exitOnError: false },
+  );
+}
+
+module.exports = createTasks;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstacksjs/eslint-config",
-  "version": "7.1.0",
+  "version": "7.2.0",
   "license": "MIT",
   "author": "fullstacks <fullstacksjs@gmail.com>",
   "description": "fullstacks eslint config",
@@ -11,7 +11,11 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
+  "bin": {
+    "fullstacksjs-eslint": "./bin/index.js"
+  },
   "files": [
+    "bin",
     "rules",
     "base.js",
     "index.js",
@@ -61,12 +65,15 @@
     "eslint": "8.5.0",
     "eslint-find-rules": "4.0.0",
     "husky": "7.0.4",
-    "lint-staged": "12.1.3",
+    "inquirer": "8.2.0",
+    "lint-staged": "12.1.2",
+    "listr": "0.14.3",
     "np": "7.6.0",
     "npm-run-all": "4.1.5",
     "pinst": "2.1.6",
     "prettier": "2.5.1",
-    "typescript": "4.5.4"
+    "typescript": "4.5.4",
+    "yargs": "17.3.1"
   },
   "peerDependencies": {
     "cypress": ">=8",

package/rules/strict.js

@@ -16,6 +16,10 @@ module.exports = {
         selector: 'default',
         format: ['camelCase'],
       },
+      {
+        selector: 'function',
+        format: ['camelCase', 'PascalCase'],
+      },
       // variables, CONSTANTS, ReactComponents
       {
         selector: 'variable',
@@ -23,7 +27,7 @@ module.exports = {
       },
       {
         selector: 'parameter',
-        format: ['camelCase'],
+        format: ['camelCase', 'PascalCase'],
         leadingUnderscore: 'allow',
       },
       {

package/rules/typescript.js

@@ -29,6 +29,58 @@ module.exports = {
     '@typescript-eslint/member-naming': 'off',
     '@typescript-eslint/member-ordering': 'off',
     '@typescript-eslint/method-signature-style': ['warn', 'property'],
+    '@typescript-eslint/naming-convention': [
+      'warn',
+      {
+        selector: 'default',
+        format: ['camelCase'],
+      },
+      {
+        selector: 'function',
+        format: ['camelCase', 'PascalCase'],
+      },
+      // variables, CONSTANTS, ReactComponents
+      {
+        selector: 'variable',
+        format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
+      },
+      {
+        selector: 'parameter',
+        format: ['camelCase', 'PascalCase'],
+        leadingUnderscore: 'allow',
+      },
+      {
+        selector: 'memberLike',
+        format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+        leadingUnderscore: 'allow',
+      },
+      {
+        selector: 'memberLike',
+        modifiers: ['static'],
+        format: ['camelCase', 'PascalCase'],
+        leadingUnderscore: 'allow',
+      },
+      {
+        selector: 'memberLike',
+        modifiers: ['private'],
+        format: ['camelCase'],
+        leadingUnderscore: 'allow',
+      },
+      {
+        selector: 'typeLike',
+        format: ['PascalCase'],
+      },
+      {
+        selector: 'enumMember',
+        format: ['PascalCase'],
+      },
+      // disallow I prefix for interfaces
+      {
+        selector: 'interface',
+        format: ['PascalCase'],
+        custom: { regex: '^I[A-Z]', match: false },
+      },
+    ],
     '@typescript-eslint/no-array-constructor': 'error',
     '@typescript-eslint/no-base-to-string': 'off', // false negative
     '@typescript-eslint/no-confusing-non-null-assertion': 'error',