@daiyam/artifact-vsx-ts 0.8.2 → 0.9.0

package/configs/.github/workflows/preview.yml

@@ -0,0 +1,70 @@
+name: Preview
+on:
+  workflow_dispatch: null
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - name: Get Version
+        run: |
+          # Get the latest tag
+          LATEST_TAG=$(git tag --sort=-v:refname | head -n1)
+          if [ -z "$LATEST_TAG" ]; then
+            echo "No tags found in the repository"
+            exit 1
+          fi
+          echo "VERSION=$LATEST_TAG" >> $GITHUB_ENV
+          echo "Using version: $LATEST_TAG"
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: '.nvmrc'
+      - name: Update package.json
+        run: |
+          TIME_PATCH="$(date +%-y)$(printf "%04d" $(($(date +%-j) * 24 + $(date +%-H))))"
+          VERSION="${VERSION#v}-$TIME_PATCH"
+          echo "Using version: $VERSION"
+
+          jq --arg version "$VERSION" '.version = $version | .preview = true' package.json > package.json.tmp
+          mv package.json.tmp package.json
+
+          jq -r '"version: \(.version)\npreview: \(.preview)"' package.json
+
+          echo "RELEASE_TAG=v$VERSION" >> $GITHUB_ENV
+      - name: Build
+        run: |
+          npm ci
+          npm install -g @vscode/vsce
+          npm run package
+          VSIX_NAME=$(ls *.vsix)
+          CHECKSUM=$(sha256sum $VSIX_NAME | cut -d ' ' -f 1)
+          echo "VSIX_NAME=$VSIX_NAME" >> $GITHUB_ENV
+          echo "CHECKSUM=$CHECKSUM" >> $GITHUB_ENV
+          echo "$CHECKSUM" > "$VSIX_NAME.sha256"
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            ${{ env.VSIX_NAME }}
+            ${{ env.VSIX_NAME }}.sha256
+          name: ${{ env.RELEASE_TAG }}
+          tag_name: ${{ env.RELEASE_TAG }}
+          prerelease: true
+          body: |
+            Release ${{ env.RELEASE_TAG }}
+
+            ## What's Changed
+
+            ## Installation
+            1. [Download the .vsix file](${{ github.server_url }}/${{ github.repository }}/releases/download/${{ env.VERSION }}/${{ env.VSIX_NAME }})
+            2. In your editor, open the Command Palette (<kbd>Meta</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>)
+            3. Type `Install from VSIX` and select the downloaded file
+
+            ## Checksum (SHA-256)
+            ```
+            ${{ env.CHECKSUM }}
+            ```

package/configs/gitignore

@@ -1,4 +1,4 @@
-lib
-out
-.vscode-test/
-*.vsix
+/lib/
+/out/
+/.vscode-test/
+/*.vsix

package/configs/package.json

@@ -12,6 +12,11 @@
 		"vscode:prepublish": "npm run compile:src && npm run bundle",
 		"watch:src": "tsc-watch -p src --onSuccess 'npm run bundle'"
 	},
+	"dependencies": {
+		"@zokugun/fs-extra-plus": "^0.3.3",
+		"@zokugun/is-it-type": "^0.5.2",
+		"@zokugun/xtry": "^0.10.1"
+	},
 	"devDependencies": {
 		"@types/vscode": "^1.23.0",
 		"release-it": "^19.2.4",

package/configs/src/commands/hello.ts

@@ -1,4 +1,4 @@
-import { getDebugChannel } from '../utils/settings.js';
+import { getDebugChannel } from '../settings.js';
 
 export async function hello(): Promise<void> {
 	const channel = getDebugChannel(true)!;

package/configs/src/document-manager.ts

@@ -1,6 +1,6 @@
 import * as vscode from 'vscode';
 import { Disposable } from './utils/disposable.js';
-import { CONFIG_KEY, getDebugChannel } from './utils/settings.js';
+import { CONFIG_KEY, getDebugChannel } from './settings.js';
 
 export class DocumentManager implements vscode.Disposable {
 	private readonly disposable: Disposable = new Disposable();

package/configs/src/extension.ts

@@ -1,7 +1,7 @@
 import vscode from 'vscode';
 import pkg from '../package.json';
 import { DocumentManager } from './document-manager.js';
-import { CONFIG_KEY, setupSettings } from './utils/settings.js';
+import { CONFIG_KEY, setupSettings } from './settings.js';
 import { hello } from './commands/hello.js';
 
 const VERSION_KEY = 'version';

package/configs/src/settings.ts

@@ -0,0 +1,33 @@
+import path from 'path';
+import fse from '@zokugun/fs-extra-plus/async';
+import { err, OK, type Result } from '@zokugun/xtry';
+import type vscode from 'vscode';
+
+export const CONFIG_KEY = 'EXT_CFG_KEY';
+
+/* eslint-disable import/no-mutable-exports, @typescript-eslint/naming-convention */
+export let EXTENSION_ID: string = '';
+export let EXTENSION_NAME: string = '';
+export let GLOBAL_STORAGE: string = '';
+export let TEMPORARY_DIR: string = '';
+export let WORKSPACE_STORAGE: string | undefined;
+/* eslint-enable */
+
+let $context: vscode.ExtensionContext | null = null;
+
+export async function setupSettings(context: vscode.ExtensionContext): Promise<Result<void, string>> {
+	EXTENSION_NAME = context.extension.packageJSON.displayName as string;
+	EXTENSION_ID = context.extension.id;
+	GLOBAL_STORAGE = context.globalStorageUri.fsPath;
+	TEMPORARY_DIR = path.join(GLOBAL_STORAGE, 'temp');
+	WORKSPACE_STORAGE = context.storageUri?.fsPath;
+
+	$context = context;
+
+	const result = await fse.ensureDir(TEMPORARY_DIR);
+	if(result.fails) {
+		return err(`Cannot ensure the directory ${TEMPORARY_DIR}`);
+	}
+
+	return OK;
+}

package/configs/src/utils/logger.ts

@@ -0,0 +1,60 @@
+import { inspect } from 'node:util';
+import { isPrimitive } from '@zokugun/is-it-type';
+import vscode, { window } from 'vscode';
+import { CONFIG_KEY } from '../settings.js';
+
+let $channel: vscode.OutputChannel | null = null;
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const Logger = {
+	debug(...args: unknown[]): void {
+		if($channel) {
+			$channel.appendLine(`[debug] ${args.map(toString).join(' ')}`);
+		}
+	},
+	error(...args: unknown[]): void {
+		const config = vscode.workspace.getConfiguration(CONFIG_KEY);
+		const showErrorAlert = config.get<boolean>('showErrorAlert') ?? true;
+
+		if(Boolean($channel) || showErrorAlert) {
+			const output = args.map(toString).join(' ');
+
+			if($channel) {
+				$channel.appendLine(`[error] ${output}`);
+			}
+
+			if(showErrorAlert) {
+				void window.showErrorMessage(`VSIX Manager: ${output}`);
+			}
+		}
+	},
+	info(...args: unknown[]): void {
+		if($channel) {
+			$channel.appendLine(`[info] ${args.map(toString).join(' ')}`);
+		}
+	},
+	setup(show: boolean = false): void {
+		const config = vscode.workspace.getConfiguration(CONFIG_KEY);
+		const debug = config.get<boolean>('debug') ?? false;
+
+		if(debug) {
+			$channel ||= vscode.window.createOutputChannel('VSIX Manager');
+		}
+
+		if(show) {
+			$channel?.show();
+		}
+	},
+	show(): void {
+		$channel?.show();
+	},
+};
+
+function toString(value: unknown): string {
+	if(isPrimitive(value)) {
+		return `${value}`;
+	}
+	else {
+		return inspect(value, { depth: null, compact: true, breakLength: Infinity });
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@daiyam/artifact-vsx-ts",
-	"version": "0.8.2",
+	"version": "0.9.0",
 	"description": "The configuration to create Visual Studio extensions and publish them on Visual Studio Marketplace and Open VSX Registry.",
 	"author": {
 		"name": "Baptiste Augrain",
@@ -31,5 +31,5 @@
 		"project-template",
 		"scaffold"
 	],
-	"gitHead": "23c10e38663fb3db36447d806495b23d74f7cc65"
+	"gitHead": "5bfb6ad591ff26ab3580a41607822157aebcf2b5"
 }

package/configs/src/utils/settings.ts

@@ -1,30 +0,0 @@
-import vscode from 'vscode';
-
-export const CONFIG_KEY = 'EXT_CFG_KEY';
-
-/* eslint-disable import/no-mutable-exports, @typescript-eslint/naming-convention */
-export let EXTENSION_NAME: string = '';
-/* eslint-enable */
-
-let $channel: vscode.OutputChannel | null = null;
-let $context: vscode.ExtensionContext | null = null;
-
-export function getContext(): vscode.ExtensionContext {
-	return $context!;
-}
-
-export function getDebugChannel(debug: boolean): vscode.OutputChannel | undefined { // {{{
-	if(debug) {
-		$channel ??= vscode.window.createOutputChannel(EXTENSION_NAME);
-
-		return $channel;
-	}
-
-	return undefined;
-} // }}}
-
-export async function setupSettings(context: vscode.ExtensionContext) {
-	EXTENSION_NAME = context.extension.packageJSON.displayName as string;
-
-	$context = context;
-}