feat: init vscode extension for auto update (#37)

antfu · web-flow · commit 21faa55aff62 · 2022-03-14T08:22:13.000+08:00
diff --git a/.eslintrc b/.eslintrc
@@ -1,3 +1,3 @@
 {
-  "extends": "@antfu/basic"
+  "extends": "@antfu"
 }
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 node_modules
 yarn.lock
+package-lock.json
 dist
+.DS_Store
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,18 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}/extension"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/extension/dist/**/*.js"
+      ],
+      "preLaunchTask": "npm: ext:dev"
+    },
+  ]
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,26 @@
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "ext:dev",
+      "isBackground": true,
+      "presentation": {
+        "reveal": "never"
+      },
+      "problemMatcher": [
+        {
+          "base": "$ts-webpack-watch",
+          "background": {
+            "activeOnStart": true,
+            "beginsPattern": "Build start",
+            "endsPattern": "Build success"
+          }
+        }
+      ],
+      "group": "build"
+    }
+  ]
+}
diff --git a/extension/.vscodeignore b/extension/.vscodeignore
@@ -0,0 +1,4 @@
+.github/**
+.vscode/**
+.vscode-test/**
+node_modules
diff --git a/extension/LICENSE b/extension/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-Present Anthony Fu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/extension/README.md b/extension/README.md
@@ -0,0 +1,35 @@
+<br>
+
+<p align="center">
+<img src="./res/logo.png" style="width:100px;" />
+</p>
+
+<h1 align="center">File Nesting Updater</h1>
+
+<p align="center">
+Auto updater for <a href="https://github.com/antfu/vscode-file-nesting-config" target="_blank"><code>vscode-file-nesting-config</code></a>
+</p>
+
+<p align="center">
+<a href="https://marketplace.visualstudio.com/items?itemName=antfu.file-nesting" target="__blank"><img src="https://img.shields.io/visual-studio-marketplace/v/antfu.file-nesting.svg?color=blue&amp;label=VS%20Code%20Marketplace&logo=visual-studio-code" alt="Visual Studio Marketplace Version" /></a>
+</p>
+
+Config to make your file tree cleaner by [the file nesting feature](https://code.visualstudio.com/updates/v1_64#_explorer-file-nesting) of VS Code.
+
+![](https://user-images.githubusercontent.com/11247099/157142238-b00deecb-8d56-424f-9b20-ef6a6f5ddf99.png)
+
+## Configurations
+
+```json
+{
+  "fileNestingUpdater.autoUpdate": true,
+  "fileNestingUpdater.autoUpdateInterval": 720,
+  "fileNestingUpdater.promptOnAutoUpdate": true,
+}
+```
+
+It will check for update every 12 hours by default. You can also do it manually by executing command `File Nesting Updater: Update config now`.
+
+## License
+
+MIT
diff --git a/extension/package.json b/extension/package.json
@@ -0,0 +1,56 @@
+{
+  "name": "file-nesting",
+  "displayName": "File Nesting Updater",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Auto updating for Anthony's file nesting config",
+  "categories": [
+    "Other"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/antfu/vscode-file-nesting-config",
+    "directory": "extension"
+  },
+  "publisher": "antfu",
+  "main": "./dist/index.js",
+  "preview": true,
+  "contributes": {
+    "commands": [
+      {
+        "command": "antfu.file-nesting.manualUpdate",
+        "title": "Update config now",
+        "category": "File Nesting Updater"
+      }
+    ],
+    "configuration": {
+      "type": "object",
+      "title": "File Nesting Updater",
+      "properties": {
+        "fileNestingUpdater.autoUpdate": {
+          "type": "boolean",
+          "description": "Fetch and update the latest config automatically",
+          "default": true
+        },
+        "fileNestingUpdater.promptOnAutoUpdate": {
+          "type": "boolean",
+          "description": "Should show up the prompt before doing auto update",
+          "default": true
+        },
+        "fileNestingUpdater.autoUpdateInterval": {
+          "type": "number",
+          "description": "The minimal interval for auto update, in minutes",
+          "default": 720
+        }
+      }
+    }
+  },
+  "activationEvents": [
+    "*"
+  ],
+  "engines": {
+    "vscode": "^1.65.0"
+  },
+  "icon": "res/logo.png"
+}
diff --git a/extension/res/logo.png b/extension/res/logo.png
diff --git a/extension/res/logo.svg b/extension/res/logo.svg
@@ -0,0 +1,6 @@
+<svg width="128" height="128" viewBox="0 0 128 128" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M59.482 91.2459V38.1282H43.1133V28.0791H80.3264V38.1282H69.5582V91.2459C69.5582 96.3995 73.8365 100.666 79.004 100.666H80.3264V110.715H79.004C68.2319 110.715 59.482 101.989 59.482 91.2459Z" fill="#888888" fill-opacity="0.3"/>
+<path d="M48.1575 17.5931L34.6146 4.05936C34.246 3.70029 33.7508 3.50061 33.2361 3.50351H10.0197C8.99344 3.50351 8.00924 3.9109 7.28359 4.63607C6.55794 5.36123 6.15027 6.34477 6.15027 7.3703V49.905C6.15027 50.9305 6.55794 51.9141 7.28359 52.6392C8.00924 53.3644 8.99344 53.7718 10.0197 53.7718H44.8443C45.8705 53.7718 46.8547 53.3644 47.5804 52.6392C48.306 51.9141 48.7137 50.9305 48.7137 49.905V18.9707C48.7166 18.4563 48.5168 17.9615 48.1575 17.5931V17.5931ZM33.2361 18.9707V8.337L43.877 18.9707H33.2361Z" fill="#F0AC5B"/>
+<path d="M122.084 17.5931L108.541 4.05936C108.172 3.70029 107.677 3.50061 107.162 3.50351H83.9457C82.9195 3.50351 81.9353 3.9109 81.2096 4.63607C80.484 5.36123 80.0763 6.34477 80.0763 7.3703V49.905C80.0763 50.9305 80.484 51.9141 81.2096 52.6392C81.9353 53.3644 82.9195 53.7718 83.9457 53.7718H118.77C119.797 53.7718 120.781 53.3644 121.506 52.6392C122.232 51.9141 122.64 50.9305 122.64 49.905V18.9707C122.643 18.4563 122.443 17.9615 122.084 17.5931V17.5931ZM107.162 18.9707V8.337L117.803 18.9707H107.162Z" fill="#F0AC5B" fill-opacity="0.5"/>
+<path d="M122.084 87.9688L108.541 74.435C108.172 74.0759 107.677 73.8763 107.162 73.8792H83.9457C82.9195 73.8792 81.9353 74.2865 81.2096 75.0117C80.484 75.7369 80.0763 76.7204 80.0763 77.7459V120.281C80.0763 121.306 80.484 122.29 81.2096 123.015C81.9353 123.74 82.9195 124.147 83.9457 124.147H118.77C119.797 124.147 120.781 123.74 121.506 123.015C122.232 122.29 122.64 121.306 122.64 120.281V89.3463C122.643 88.8319 122.443 88.3371 122.084 87.9688V87.9688ZM107.162 89.3463V78.7126L117.803 89.3463H107.162Z" fill="#F0AC5B" fill-opacity="0.5"/>
+</svg>
diff --git a/extension/src/config.ts b/extension/src/config.ts
@@ -0,0 +1,14 @@
+import { workspace } from 'vscode'
+
+export function getConfig<T = any>(key: string): T | undefined {
+  return workspace
+    .getConfiguration()
+    .get<T>(key)
+}
+
+export async function setConfig(key: string, value: any, isGlobal = true) {
+  // update value
+  return await workspace
+    .getConfiguration()
+    .update(key, value, isGlobal)
+}
diff --git a/extension/src/constants.ts b/extension/src/constants.ts
@@ -0,0 +1,2 @@
+export const URL = 'https://cdn.jsdelivr.net/gh/antfu/vscode-file-nesting-config@main/README.md'
+export const MSG_PREFIX = 'File Nesting Updater:'
diff --git a/extension/src/fetch.ts b/extension/src/fetch.ts
@@ -0,0 +1,54 @@
+import fetch from 'node-fetch'
+import type { ExtensionContext } from 'vscode'
+import { window, workspace } from 'vscode'
+import { MSG_PREFIX, URL } from './constants'
+
+export async function fetchLatest() {
+  const md = await fetch(URL).then(r => r.text())
+  const content = (md.match(/```jsonc([\s\S]*?)```/) || [])[1] || ''
+
+  const json = `{${
+    content
+      .trim()
+      .split(/\n/g)
+      .filter(line => !line.trim().startsWith('//'))
+      .join('\n')
+      .slice(0, -1)
+  }}`
+
+  const config = JSON.parse(json) || {}
+  return config['explorer.experimental.fileNesting.patterns']
+}
+
+export async function fetchAndUpdate(ctx: ExtensionContext, prompt = true) {
+  const patterns = await fetchLatest()
+  let shouldUpdate = true
+
+  if (prompt) {
+    const buttonUpdate = 'Update'
+    const buttonSkip = 'Skip this time'
+    const result = await window.showInformationMessage(
+      `${MSG_PREFIX} new config found, do you want to update?`,
+      buttonUpdate,
+      buttonSkip,
+    )
+    shouldUpdate = result === buttonUpdate
+  }
+
+  if (shouldUpdate) {
+    const config = workspace.getConfiguration()
+    if (!config.has('explorer.experimental.fileNesting.enabled'))
+      config.update('explorer.experimental.fileNesting.enabled', true, true)
+    if (!config.has('explorer.experimental.fileNesting.expand'))
+      config.update('explorer.experimental.fileNesting.expand', false, true)
+
+    config.update('explorer.experimental.fileNesting.patterns', {
+      '//': `Last update at ${new Date().toLocaleString()}`,
+      ...patterns,
+    }, true)
+
+    ctx.globalState.update('lastUpdate', Date.now())
+
+    window.showInformationMessage(`${MSG_PREFIX} Config updated`)
+  }
+}
diff --git a/extension/src/index.ts b/extension/src/index.ts
@@ -0,0 +1,18 @@
+import type { ExtensionContext } from 'vscode'
+import { commands } from 'vscode'
+import { getConfig } from './config'
+import { fetchAndUpdate } from './fetch'
+
+export async function activate(ctx: ExtensionContext) {
+  commands.registerCommand('antfu.file-nesting.manualUpdate', () => fetchAndUpdate(ctx, false))
+
+  const lastUpdate = ctx.globalState.get('lastUpdate', 0)
+  const autoUpdateInterval = getConfig<number>('fileNestingUpdater.autoUpdateInterval')
+
+  if (getConfig('fileNestingUpdater.autoUpdate')) {
+    if (Date.now() - lastUpdate >= autoUpdateInterval * 60_000)
+      fetchAndUpdate(ctx, getConfig('fileNestingUpdater.promptOnAutoUpdate'))
+  }
+}
+
+export function deactivate() {}
diff --git a/package.json b/package.json
@@ -1,15 +1,26 @@
 {
   "private": true,
+  "workspaces": [
+    "extension"
+  ],
   "license": "MIT",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "funding": "https://github.com/sponsors/antfu",
   "scripts": {
     "update": "node update.mjs",
-    "lint": "eslint --ext .js,.json .",
-    "lint:fix": "npm run lint -- --fix"
+    "lint": "eslint --ext .",
+    "lint:fix": "npm run lint -- --fix",
+    "ext:build": "cd extension && tsup src/index.ts --external vscode",
+    "ext:dev": "nr ext:build --watch src",
+    "ext:publish": "nr ext:build && cd extension && vsce publish"
   },
   "devDependencies": {
-    "@antfu/eslint-config-basic": "^0.18.6",
-    "eslint": "^8.10.0"
+    "@antfu/eslint-config": "^0.18.8",
+    "@antfu/ni": "^0.13.2",
+    "@types/vscode": "^1.65.0",
+    "eslint": "^8.11.0",
+    "node-fetch": "^3.2.3",
+    "tsup": "^5.12.1",
+    "typescript": "^4.6.2"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- "extends": "@antfu/basic"`
	`2`	`+ "extends": "@antfu"`
`3`	`3`	`}`