✨ Adds line highlighting option, shipping #50

mixn · Apr 27, 2023 · 2655817 · 2655817
1 parent 4226c51
commit 2655817
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 14 deletions.
diff --git a/src/config/cli/default-settings.config.ts b/src/config/cli/default-settings.config.ts
@@ -1,5 +1,5 @@
-// For my own (and others) sanity,
-// this is commented JS, instead of uncommented JSON
+// Keys here are based on the corresponding Carbon query params,
+// so we can avoid further string mapping, e.g., `dropShadow` ➝ `ds`
 const defaultSettings: CarbonCLIPresetInterface = {
   // Theme
   t: 'seti',
@@ -22,6 +22,8 @@ const defaultSettings: CarbonCLIPresetInterface = {
   dsyoff: '20px',
   // Drop shadow blur
   dsblur: '68px',
+  // Selected lines aka. highlighted lines
+  sl: '*',
   // Auto adjust width
   wa: true,
   // Line height

diff --git a/src/config/cli/prompt.config.ts b/src/config/cli/prompt.config.ts
@@ -91,6 +91,19 @@ export default [
     default: '68px',
     when: (answers: CarbonCLIPromptAnswersInterface) => answers.ds,
   },
+  {
+    type: 'confirm',
+    name: 'highlight',
+    message: 'Highlight certain lines?',
+    default: false,
+  },
+  {
+    type: 'input',
+    name: 'sl',
+    message: 'Comma-separated list of lines to highlight, e.g., 4,5,6,7',
+    default: '*',
+    when: (answers: CarbonCLIPromptAnswersInterface) => answers.highlight,
+  },
   {
     type: 'confirm',
     name: 'si',

diff --git a/src/modules/preset-handler.module.ts b/src/modules/preset-handler.module.ts
@@ -10,6 +10,8 @@ import {
 import presetMissingView from '../views/preset-missing.view.js';
 
 export default class PresetHandler {
+  private readonly ignoredSettings = ['save', 'preset', 'l', 'highlight'];
+
   constructor(private readonly configPath: string = CONFIG_PATH) {}
 
   private async writeConfig(
@@ -53,11 +55,10 @@ export default class PresetHandler {
     preset = CONFIG_LATEST_PRESET,
     presetSettings = {}
   ): Promise<void> {
-    const whiteListedSettings = lodash.omit(presetSettings, [
-      'save',
-      'preset',
-      'l',
-    ]);
+    const whiteListedSettings = lodash.omit(
+      presetSettings,
+      this.ignoredSettings
+    );
     const currentConfig = await this.readConfig();
     const upcomingConfig = {
       ...currentConfig,

diff --git a/src/types/cli/global.d.ts b/src/types/cli/global.d.ts
@@ -41,6 +41,7 @@ interface CarbonCLIPresetInterface {
   ds: boolean;
   dsyoff: string;
   dsblur: string;
+  sl: string;
   wa: boolean;
   lh: string;
   pv: string;
@@ -59,6 +60,7 @@ declare interface CarbonCLIPromptAnswersInterface
   extends CarbonCLIPresetInterface {
   dsyoff?: string;
   dsblur?: string;
+  highlight: string;
   t: CarbonCLIThemeType;
   wt: 'None' | 'Sharp' | 'Black & White';
   fm: CarbonFontFamilyType;

diff --git a/test/e2e/index.test.ts b/test/e2e/index.test.ts
@@ -8,6 +8,7 @@ import {
   DUMMY_INPUT,
   DUMMY_FILE,
   DUMMY_TARGET,
+  DUMMY_CONFIG,
 } from '../helpers/constants.helper.js';
 import readFileAsync from '../../src/utils/read-file-async.util.js';
 
@@ -16,7 +17,6 @@ const DEFAULT_SCRIPT = `${SCRIPT} ${DUMMY_FILE}`;
 const DUMMY_LOCATION = 'location';
 const DUMMY_SAVED_FILE_NAME = `${DUMMY_TARGET}.png`;
 const ABSENT_DUMMY_CONFIG = './non-existent.json';
-const PRESENT_DUMMY_CONFIG = './test/test-dummies/_config.json';
 
 afterEach(async () => {
   await del([DUMMY_SAVED_FILE_NAME], {
@@ -48,11 +48,11 @@ describe('Running `carbon-now` command', () => {
   });
 
   it('shouldn’t modify local --config, but instead treat it as read-only', async () => {
-    const CONFIG_BEFORE = await readFileAsync(PRESENT_DUMMY_CONFIG);
+    const CONFIG_BEFORE = await readFileAsync(DUMMY_CONFIG);
     await execa.command(
-      `${DEFAULT_SCRIPT} --config=${PRESENT_DUMMY_CONFIG} -t=${DUMMY_TARGET}`
+      `${DEFAULT_SCRIPT} --config=${DUMMY_CONFIG} -t=${DUMMY_TARGET}`
     );
-    const CONFIG_AFTER = await readFileAsync(PRESENT_DUMMY_CONFIG);
+    const CONFIG_AFTER = await readFileAsync(DUMMY_CONFIG);
     expect(CONFIG_BEFORE).toBe(CONFIG_AFTER);
   });
 

diff --git a/test/helpers/constants.helper.ts b/test/helpers/constants.helper.ts
@@ -2,6 +2,7 @@ import { HOMEDIR } from '../../src/helpers/cli/constants.helper.js';
 
 const CONFIG_DUMMY = '.carbon-now-dummy.json';
 export const DUMMY_FILE = './test/test-dummies/_unfold.js';
+export const DUMMY_CONFIG = './test/test-dummies/_config.json';
 export const DUMMY_INPUT = '<owen-wilson says="Wow" />';
 export const DUMMY_TARGET = 'target';
 export const DUMMY_LOCATION = '~/something';

diff --git a/test/modules/preset-handler.module.test.ts b/test/modules/preset-handler.module.test.ts
@@ -6,6 +6,7 @@ import { CONFIG_LATEST_PRESET } from '../../src/helpers/cli/constants.helper.js'
 import {
   CONFIG_DUMMY_PATH,
   CONFIG_MISSING_PRESET,
+  DUMMY_CONFIG,
 } from '../helpers/constants.helper.js';
 import presetMissingView from '../../src/views/preset-missing.view.js';
 
@@ -101,14 +102,13 @@ describe('PresetHandlerModule', () => {
 
   it('should handle local configs correctly', async () => {
     expect(
-      await new PresetHandlerModule(
-        './test/test-dummies/_config.json'
-      ).getPreset(DUMMY_PRESET_NAME_1)
+      await new PresetHandlerModule(DUMMY_CONFIG).getPreset(DUMMY_PRESET_NAME_1)
     ).toEqual({
       bg: 'white',
       ds: true,
       dsblur: '5px',
       dsyoff: '5px',
+      sl: '*',
       es: '2x',
       fm: 'Inconsolata',
       fs: '16px',

diff --git a/test/test-dummies/_config.json b/test/test-dummies/_config.json
@@ -10,6 +10,7 @@
     "ds": true,
     "dsyoff": "5px",
     "dsblur": "5px",
+		"sl": "*",
     "wa": true,
     "lh": "133%",
     "pv": "20px",