feat: save disabled state

Author: magicdawn

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v0.6.0 2023-03-31
+
+- save disabled state in `vsc-custom ls` command
+- new command: rm added via `vsc-custom rm` command
+
 ## v0.5.0 2022-12-08
 
 - warn on local file not exist

src/cli.ts

@@ -1,4 +1,4 @@
-import { Cli, Builtins } from 'clipanion'
+import { Builtins, Cli } from 'clipanion'
 import { PackageJson } from 'type-fest'
 const { version, name, bin } = require('../package') as PackageJson
 
@@ -17,6 +17,9 @@ cli.register(Builtins.DefinitionsCommand)
 import { AddCommand } from './commands/add'
 cli.register(AddCommand)
 
+import { RemoveCommand } from './commands/remove'
+cli.register(RemoveCommand)
+
 import { UpdateCommand } from './commands/update'
 cli.register(UpdateCommand)
 

src/commands/add.ts

@@ -48,6 +48,6 @@ export class AddCommand extends Command {
     add(file)
     await applyData()
 
-    consola.log('[vsc-custom]: embed file success %s', file)
+    consola.success('[vsc-custom]: embed file success %s', file)
   }
 }

src/commands/common.ts

@@ -1,12 +1,15 @@
 import cheerio, { CheerioAPI } from 'cheerio'
 import consola from 'consola'
+import debugFactory from 'debug'
 import fse from 'fs-extra'
 import path from 'path'
 import pmap from 'promise.map'
 import { APP_DIR, DATA_ATTR_NAME, HTML_FILE } from '../config'
 import { CURRENT_ASSETS } from '../data'
 import { checkChecksum, chown, getContent } from '../utils'
 
+const debug = debugFactory('vsc-custom:common')
+
 export async function prepare() {
   let ok = true
   try {
@@ -42,14 +45,19 @@ export async function applyData() {
 
   // update contents
   const listData = await pmap(
-    CURRENT_ASSETS,
-    async (file) => {
+    CURRENT_ASSETS.filter((x) => !x.disabled),
+    async ({ file }) => {
       const content = await getContent(file)
       return { file, content }
     },
     5
   )
 
+  debug(
+    'after filter out disabled: %O',
+    listData.map((x) => x.file)
+  )
+
   // create new tags
   for (let { file, content } of listData) {
     const ext = path.extname(file)

src/commands/list.ts

@@ -1,6 +1,6 @@
 import { Command, Usage } from 'clipanion'
 import inquirer from 'inquirer'
-import { CURRENT_ASSETS, write } from '../data'
+import { AddedAsset, CURRENT_ASSETS, write } from '../data'
 import { applyData } from './common'
 
 export class ListCommand extends Command {
@@ -12,20 +12,19 @@ export class ListCommand extends Command {
   }
 
   async execute() {
-    const list = CURRENT_ASSETS
     const { selectedIndex } = await inquirer.prompt([
       {
         type: 'checkbox',
         message: 'choose from list',
         name: 'selectedIndex',
-        choices: CURRENT_ASSETS.map((item, index) => {
-          return { name: item, value: index, checked: true }
+        choices: CURRENT_ASSETS.map((asset, index) => {
+          return { name: asset.file, value: index, checked: !asset.disabled }
         }),
       },
     ])
 
-    const newList = CURRENT_ASSETS.filter((item, index) => {
-      return selectedIndex.includes(index)
+    const newList: AddedAsset[] = CURRENT_ASSETS.map((item, index) => {
+      return { ...item, disabled: !selectedIndex.includes(index) }
     })
     write(newList)
 

src/commands/remove.ts

@@ -0,0 +1,29 @@
+import { Command, Option, Usage } from 'clipanion'
+import consola from 'consola'
+import path from 'path'
+import { remove } from '../data'
+import { isUrl } from '../utils'
+import { applyData } from './common'
+
+export class RemoveCommand extends Command {
+  static paths = [['remove'], ['rm']]
+
+  static usage: Usage = {
+    category: '',
+    description: `remove previously added file or url`,
+    details: '',
+    examples: [[`remove file`, `$0 remove ./custom.css`]],
+  }
+
+  file = Option.String({ required: true })
+
+  async execute() {
+    let { file } = this
+    if (!isUrl(file)) file = path.resolve(file)
+
+    remove(file)
+    await applyData()
+
+    consola.success('[vsc-custom]: remove file success %s', file)
+  }
+}

src/data.ts

@@ -7,41 +7,63 @@ import { PackageJson } from 'type-fest'
 const { name } = require('../package.json') as PackageJson
 const paths = envPaths(name, { suffix: '' })
 
+export type AddedAsset = { file: string; disabled: boolean }
+
 export const dataFile = path.join(paths.data, 'added-assets.json')
 
-type AddedAssets = string[]
+export let CURRENT_ASSETS: AddedAsset[] = []
 
-export let CURRENT_ASSETS: AddedAssets = []
+// 兼容之前 string[] 的数据
+type CompatibleJson = (string | AddedAsset)[]
+function toAssets(compatibleJSON: CompatibleJson) {
+  return compatibleJSON.map((item) => {
+    if (typeof item === 'string') return { file: item, disabled: false }
+    return item
+  })
+}
 
 export function read() {
-  let json = fse.readJSONSync(dataFile, { throws: false }) as AddedAssets
+  const json = fse.readJSONSync(dataFile, { throws: false }) as CompatibleJson
 
   if (!json) {
-    json = [] as AddedAssets
-    write(json)
+    write([])
+    return []
   }
 
-  CURRENT_ASSETS = json
-  return json
+  return (CURRENT_ASSETS = toAssets(json))
 }
 
 // read on start
 consola.info('[vsc-custom]: using data file: %s', dataFile)
 read()
 
-export function write(data: AddedAssets) {
+export function write(data: AddedAsset[]) {
   CURRENT_ASSETS = data
   fse.outputJSONSync(dataFile, data)
 }
 
-export function add(item: string) {
-  const items = read()
-
-  if (items.includes(item)) {
-    items.splice(items.indexOf(item), 1)
+const _remove = (file: string) => {
+  const index = CURRENT_ASSETS.findIndex((i) => i.file === file)
+  if (index !== -1) {
+    CURRENT_ASSETS.splice(index, 1)
   }
+}
+
+export function add(file: string) {
+  // rm
+  _remove(file)
+
+  // add
+  CURRENT_ASSETS.push({ file, disabled: false })
+
+  // persist
+  write(CURRENT_ASSETS)
+}
+
+export function remove(file: string) {
+  // rm
+  _remove(file)
 
-  items.push(item)
-  write(items)
-  return items
+  // persist
+  write(CURRENT_ASSETS)
 }