build: prepare release

update documentation / changelog
remove useless copies / types

Author: BoxBoxJason

.gitignore

@@ -2,3 +2,4 @@ dist/
 .vscode/
 node_modules/
 author.sh
+*.vsix

CHANGELOG.md

@@ -2,8 +2,45 @@
 
 All notable changes to the "achievements" extension will be documented in this file.
 
-Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
-## [Unreleased]
+## [0.0.1] | 2024-11-?? - Initial release
 
-- Initial release
+Initial release of Achievements
+
+### Added
+
+- Over 1200 achievements
+    - Git related
+    - Code related
+    - Debugging related
+    - Testing related
+    - Refactoring related
+    - Commenting related
+    - File related
+    - More...
+- Profile
+    - View your profile and completion percentage
+    - View your time spent coding
+    - Check your progressions towards achievements
+- Achievements panel
+    - View achievements
+    - View progress towards achievements
+    - View achievement descriptions
+    - Filter achievements by category
+    - Filter achievements by progress
+    - Filter achievements by name
+- Configuration
+    - Enable / disable extension
+    - Enable / disable notifications
+    - Enable / disable any type of listeners (for privacy)
+    - Define your username
+    - Select log level
+    - Select log directory
+
+- Database
+    - Database model for achievements
+    - Database model for progressions
+    - Database model for requirements
+    - Database model for database schema
+    - Migration manager for database schema
+    - Initial achievements populated in database

README.md

@@ -2,67 +2,47 @@
 
 Achievements is a Visual Studio Code extension that allows you to track your progress in coding, and earn achievements for completing tasks.
 
+![Extension Webview Illustration](./screenshot.jpg)
+
 ## Features
 
 - Track your progress in coding
 - Earn achievements for completing tasks
 - View your achievements in the **Achievements** panel
 - View each achievement's description and requirements
 - View your progress towards each achievement
+- Track your time spent coding
+- Filter achievements by category, progress, and name
+- View your profile and completion percentage
+- Enable or disable notifications
+- Enable or disable any type of listeners for **privacy**
 
 ## Extension Commands
 
-### Configuration commands
-- `achievements.enable`: Enables the Achievements extension.
-- `achievements.disable`: Disables the Achievements extension.
-- `achievements.configuration`: Opens the Achievements configuration page.
-- `achievements.notifications`: Enables or disables notifications for achievements.
-
-### Achievement commands
-- `achievements.show`: Opens the Achievements panel.
-
-## Release Notes
-
-### [0.0.1] | 2024-11-?? - Initial release
-
-Initial release of Achievements
-
-#### Added
-- Over 1200 achievements
-    - Git related
-    - Code related
-    - Debugging related
-    - Testing related
-    - Refactoring related
-    - Commenting related
-    - File related
-    - More...
-- Profile
-    - View your profile and completion percentage
-    - View your time spent coding
-    - Check your progressions towards achievements
-- Achievements panel
-    - View achievements
-    - View progress towards achievements
-    - View achievement descriptions
-    - Filter achievements by category
-    - Filter achievements by progress
-    - Filter achievements by name
-- Configuration
-    - Enable / disable extension
-    - Enable / disable notifications
-    - Enable / disable any type of listeners (for privacy)
-    - Define your username
-    - Select log level
-    - Select log directory
-
-- Database
-    - Database model for achievements
-    - Database model for progressions
-    - Database model for requirements
-    - Database model for database schema
-    - Migration manager for database schema
-    - Initial achievements populated in database
-
-## Known Issues
-
+Several commands are available to interact with the Achievements extension. You can access these commands through the Command Palette (Ctrl+Shift+P) or by using keybindings.
+
+|Command|Description|
+|---|---|
+|`achievements.enable`|Enable or Disable the Achievements extension event tracking (requires a restart)|
+|`achievements.settings`|Open the Achievements configuration page|
+|`achievements.show`|Show the Achievements panel|
+
+## Configuration
+
+The Achievements extension can be configured through the settings. You can access the settings by going to **File > Preferences > Settings** and searching for "Achievements".
+You can also access the settings by using the command `achievements.settings`.
+
+|Setting|Description|
+|---|---|
+|`achievements.enabled`|Enable or disable the Achievements extension event tracking|
+|`achievements.notifications`|Enable or disable notifications for achievements|
+|`achievements.logDirectory`|Select the directory where the log files will be stored|
+|`achievements.logLevel`|Select the log level (info, debug, error)|
+|`achievements.username`|Define your username for the Achievements score display|
+|`achievements.listeners.debug`|Enable or disable debug listeners|
+|`achievements.listeners.git`|Enable or disable git listeners|
+|`achievements.listeners.extensions`|Enable or disable extension listeners|
+|`achievements.listeners.files`|Enable or disable file listeners|
+|`achievements.listeners.tabs`|Enable or disable tab listeners|
+|`achievements.listeners.tasks`|Enable or disable task listeners|
+|`achievements.listeners.time`|Enable or disable time tracking listeners|

esbuild.ts

@@ -26,8 +26,6 @@ const esbuildProblemMatcherPlugin: esbuild.Plugin = {
 };
 
 async function main() {
-  // Copy the images to the dist folder
-  await fs.copy('assets', 'dist', { overwrite: true });
   // Build for webview React code
   const ctxWebview = await esbuild.context({
     entryPoints: [...constants.build.WEBVIEW_ENTRYPOINTS],

screenshot.jpg

@@ -319,7 +319,7 @@ export namespace StackingTemplates {
   export namespace vscode {
     //////////////////////// VSCODE STACKING TEMPLATES ////////////////////////
     export const extensionsInstalledTemplate = (): StackingAchievementTemplate => ({
-      title: 'Got to catch them all ! %d',
+      title: 'Buying Frenzy %d',
       icon: 'EXTENSION_MASTER',
       category: constants.category.VSCODE,
       group: 'Extensions Installed',

src/database/model/init/StackingTemplates.ts

@@ -6,7 +6,6 @@
  */
 
 import * as vscode from 'vscode';
-import type { GitExtension, Repository } from '../../types/git';
 import logger from '../utils/logger';
 import { ProgressionController } from '../database/controller/progressions';
 import { constants } from '../constants';
@@ -30,7 +29,7 @@ export namespace gitListeners {
     if (config.isListenerEnabled(constants.listeners.GIT)) {
       logger.info('Starting git events listeners');
 
-      const gitExtension = vscode.extensions.getExtension('vscode.git')?.exports as GitExtension;
+      const gitExtension = vscode.extensions.getExtension('vscode.git')?.exports as any;
       if (!gitExtension) {
         logger.error('Git extension not found, git listeners will not be created');
         return;
@@ -39,14 +38,14 @@ export namespace gitListeners {
       const gitAPI = gitExtension.getAPI(1);
 
       // Handle current workspace repositories commits
-      gitAPI.repositories.forEach((repository: Repository) => {
+      gitAPI.repositories.forEach((repository: any) => {
         repository.onDidCommit(() => {
           ProgressionController.increaseProgression(constants.criteria.COMMITS);
         }, null, context.subscriptions);
       });
 
       // Handle new repositories commits
-      gitAPI.onDidOpenRepository((repository: Repository) => {
+      gitAPI.onDidOpenRepository((repository: any) => {
         repository.onDidCommit(() => {
           ProgressionController.increaseProgression(constants.criteria.COMMITS);
         }, null, context.subscriptions);

src/listeners/git.ts

@@ -33,7 +33,7 @@ export function getPackagedImages(context: vscode.ExtensionContext, view: vscode
   };
 
   for (const key in iconsMap) {
-    images[key] = getWebviewImageUri(context, view, path.join('dist', ...iconsMap[key])).toString();
+    images[key] = getWebviewImageUri(context, view, path.join('assets', ...iconsMap[key])).toString();
   }
 
   return images;