add comments

mongodb · Oct 16, 2024 · 5dd551d · 5dd551d
1 parent 1f1be18
commit 5dd551d
Show file tree

Hide file tree

Showing 3 changed files with 1,503 additions and 143 deletions.
diff --git a/tools/eslint-plugin/scripts/buildRulesIndex.ts b/tools/eslint-plugin/scripts/buildRulesIndex.ts
@@ -5,6 +5,10 @@ import { makeId, makeVarName } from './utils';
 
 buildRulesIndexFile();
 
+/**
+ * Utility function that creates or updates the Rules index file
+ * after a new Rule is created
+ */
 export function buildRulesIndexFile() {
   const rulesDir = path.resolve(__dirname, '../src/rules');
   fse.readdir(rulesDir).then(files => {

diff --git a/tools/eslint-plugin/scripts/createNewRule.ts b/tools/eslint-plugin/scripts/createNewRule.ts
@@ -13,8 +13,11 @@ import {
 const cli = new Command('');
 cli.argument('<rule-name>', 'The name of the rule');
 cli.action(createNewRule);
-cli.parse();
+cli.parse(process.argv);
 
+/**
+ * Creates a new Rule within `eslint-plugin/src/rules`
+ */
 function createNewRule(ruleName: string) {
   const rulesDir = path.resolve(__dirname, '../src/rules');
   const testsDir = path.resolve(__dirname, '../src/tests');