feat: add config file flag

tomcarman · May 21, 2024 · 193c6db · 193c6db
1 parent a21027c
commit 193c6db
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/messages/metalint.run.md b/messages/metalint.run.md
@@ -25,3 +25,7 @@ You must provide a folder to lint - eg. force-app
 # flags.format.summary
 
 Specifies the output format for results.
+
+# flags.config.summary
+
+YAML config file defining rules and settings.
diff --git a/src/commands/metalint/run.ts b/src/commands/metalint/run.ts
@@ -22,6 +22,12 @@ export default class MetalintRun extends SfCommand<MetalintRunResult> {
   public static readonly examples = messages.getMessages('examples');
 
   public static readonly flags = {
+    config: Flags.file({
+      summary: messages.getMessage('flags.config.summary'),
+      char: 'c',
+      required: true,
+      exists: true,
+    }),
     directory: Flags.directory({
       summary: messages.getMessage('flags.directory.summary'),
       char: 'd',
@@ -38,6 +44,7 @@ export default class MetalintRun extends SfCommand<MetalintRunResult> {
 
   public async run(): Promise<MetalintRunResult> {
     const { flags } = await this.parse(MetalintRun);
+    const config = flags['config'];
     const dir = flags['directory'];
     const format = flags['format'];
 
@@ -63,7 +70,7 @@ export default class MetalintRun extends SfCommand<MetalintRunResult> {
     results = resultFormatters[format](ruleResults);
     this.spinner.stop();
 
-    await readConfigFile();
+    await readConfigFile(config);
 
     this.log(results);
 

diff --git a/src/common/config-parser.ts b/src/common/config-parser.ts
@@ -3,8 +3,8 @@ import yaml from 'js-yaml';
 import * as yup from 'yup';
 import { ConfigFile } from '../common/types.js';
 
-export async function readConfigFile(): Promise<void> {
-  const loadedConfig = yaml.load(fs.readFileSync('demo/config.yaml', 'utf8'));
+export async function readConfigFile(configFile: string): Promise<void> {
+  const loadedConfig = yaml.load(fs.readFileSync(configFile, 'utf8'));
 
   const configSchema = yup.object().shape({
     version: yup.number().required(),