v1.0.0

Author: ccjmk

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Commander - FoundryVTT at your fingertips
 
+## v1.0.0 (2022-09-02)
+- Added welcome message, and improved `i(nfo)` and `help` commands.
+- Manifest migration for v10
+- Full suggestions with up/down arrow keys
+- Renamed Application class from Widget -> Commander to make the foundry rendering console log less generic-looking (No more "Foundry VTT | Rendering Widget" without any clear finger pointing at Commander)
+- Fixed 'Open Compendium (comp)' command to not create a new Compendium instance and use the exiting app con the compendium (This caused that the open windows would not reflect changes on the underlying compendium even when they were happening in the background).
+
+
 ## v0.1.0 (2022-02-19)
 - Initial Release
 - Complete functionality, but pending some improvements before calling it v1.0.0

README.md

@@ -13,13 +13,14 @@ This module provides the command-line input and the API for registering new comm
 
 ## Bundled Commands
 
-* Command info (i)
-* Log commands the current use can use (cmd:allowed)
+* Command info (info $command)
+* Show commands the current user can use (help)
 * Open tab (go $tab)
 * Open compendium (comp $title)
 * Run macro by name (m $name)
-* Open character sheet by Player name (sheet:player $name)
-* Open character sheet by Actor name (sheet:name $name)
+* Open character sheet by Player name (player $name)
+* Open character sheet by Actor name (pc $name)
+* Open non-player character sheet by name (npc $name)
 * Apply active effect to selected tokens -just visual- (tae $effect)
 
 It is not the intention of this module to provide commands specific to particular systems, but mostly the tooling and more generic commands applicable to anyone regardless of game system. If you have such a command that you want to share, [don't be afraid to open a pull request](https://github.com/ccjmk/commander/pulls)!
@@ -28,9 +29,9 @@ It is not the intention of this module to provide commands specific to particula
 
 ## Executing Commands
 
-You can open the Commander widget by pressing the corresponding keybinding, configurable in-game, with the default been Ctrl+Backtick.  *(the ` right next to the 1 in english keyboards)*
+You can open the Commander widget by pressing (by default) Alt+Backtick *(the \` right next to the 1 in english keyboards)*. Shortcut is configurable ingame using the default keybinding menu.
 
-Then you can start typing! Command suggestions will pop up as you type, you can auto-accept the selected suggestion with `Tab`/`Enter`, or select other suggestions using `Up` or `Down`. An `Enter` when no suggestion is selected sends the Command for execution.
+Then you can start typing! Command suggestions will pop up as you type, you can auto-accept the selected suggestion with `Tab`/`Enter`, or select other suggestions using `Up` or `Down`. An `Enter` when no suggestion is selected sends the Command for execution, else it auto-fills that suggestion.
 
 ## Licensing
 

foundryconfig.example.json

@@ -1,3 +1,3 @@
 {
-  "dataPath": "/absolute/path/to/your/FoundryVTT"
+  "dataPath": ["/absolute/path/to/your/FoundryVTT"]
 }

gulpfile.js

@@ -89,17 +89,26 @@ async function clean() {
 /**
  * Get the data path of Foundry VTT based on what is configured in `foundryconfig.json`
  */
-function getDataPath() {
+function getDataPaths() {
   const config = fs.readJSONSync('foundryconfig.json');
-
-  if (config?.dataPath) {
-    if (!fs.existsSync(path.resolve(config.dataPath))) {
-      throw new Error('User Data path invalid, no Data directory found');
-    }
-
-    return path.resolve(config.dataPath);
+  const dataPath = config?.dataPath;
+
+  if (dataPath) {
+    const dataPaths = Array.isArray(dataPath) ? dataPath : [dataPath];
+
+    return dataPaths.map((dataPath) => {
+      if (typeof dataPath !== 'string') {
+        throw new Error(
+          `Property dataPath in foundryconfig.json is expected to be a string or an array of strings, but found ${dataPath}`,
+        );
+      }
+      if (!fs.existsSync(path.resolve(dataPath))) {
+        throw new Error(`The dataPath ${dataPath} does not exist on the file system`);
+      }
+      return path.resolve(dataPath);
+    });
   } else {
-    throw new Error('No User Data path defined in foundryconfig.json');
+    throw new Error('No dataPath defined in foundryconfig.json');
   }
 }
 
@@ -111,19 +120,23 @@ async function linkUserData() {
   if (fs.existsSync(path.resolve(sourceDirectory, 'module.json'))) {
     destinationDirectory = 'modules';
   } else {
-    throw new Error('Could not find module.json');
+    throw new Error(`Could not find ${chalk.blueBright('module.json')}`);
   }
 
-  const linkDirectory = path.resolve(getDataPath(), 'Data', destinationDirectory, name);
+  const linkDirectories = getDataPaths().map((dataPath) => path.resolve(dataPath, 'Data', destinationDirectory, name));
 
-  if (argv.clean || argv.c) {
-    console.log(`Removing build in ${linkDirectory}.`);
+  for (const linkDirectory of linkDirectories) {
+    if (argv.clean || argv.c) {
+      console.log(`Removing build in ${linkDirectory}.`);
 
-    await fs.remove(linkDirectory);
-  } else if (!fs.existsSync(linkDirectory)) {
-    console.log(`Linking dist to ${linkDirectory}.`);
-    await fs.ensureDir(path.resolve(linkDirectory, '..'));
-    await fs.symlink(path.resolve(distDirectory), linkDirectory);
+      await fs.remove(linkDirectory);
+    } else if (!fs.existsSync(linkDirectory)) {
+      console.log(`Linking dist to ${linkDirectory}.`);
+      await fs.ensureDir(path.resolve(linkDirectory, '..'));
+      await fs.symlink(path.resolve(distDirectory), linkDirectory);
+    } else {
+      console.log(`SKIPPING - link to ${linkDirectory} already exists`);
+    }
   }
 }
 

package.json

@@ -14,6 +14,9 @@
   "contributors": [
     {
       "name": "Iñaki 'ccjmk' Guastalli"
+    },
+    {
+      "name": "Miguel Galante"
     }
   ],
   "scripts": {

rollup.config.js

@@ -2,7 +2,7 @@ const typescript = require('@rollup/plugin-typescript');
 const { nodeResolve } = require('@rollup/plugin-node-resolve');
 
 module.exports = {
-  input: { ['commander']: 'src/module/module.ts' },
+  input: { ['commander']: 'src/module/commander.ts' },
   output: {
     dir: 'dist/module',
     format: 'es',

src/module.json

@@ -1,5 +1,5 @@
 {
-  "name": "commander",
+  "id": "commander",
   "title": "Commander",
   "description": "Command launcher for running and registering commands executable by keyboard",
   "version": "This is auto replaced",
@@ -13,13 +13,18 @@
       "url": "https://www.linkedin.com/in/miguelgalante"
     }
   ],
-  "minimumCoreVersion": "9",
-  "compatibleCoreVersion": "9",
+  "compatibility": {
+    "minimum": 10,
+    "verified": "10.284"
+  },
   "scripts": [],
   "esmodules": ["module/commander.js"],
   "styles": ["styles/commander.css"],
   "packs": [],
-  "dependencies": [],
+  "relationships": {
+    "systems": [],
+    "requires": []
+  },
   "languages": [
     {
       "lang": "en",
@@ -35,6 +40,5 @@
   "readme": "This is auto replaced",
   "bugs": "This is auto replaced",
   "changelog": "This is auto replaced",
-  "system": [],
   "library": false
 }

src/module/argument.ts

@@ -1,8 +1,8 @@
-import Suggestion from './suggestion';
+import ArgumentSuggestion from './argumentSuggestion';
 import { ARGUMENT_TYPES } from './utils/moduleUtils';
 
 export default interface Argument {
   name: string;
   type: ARGUMENT_TYPES;
-  suggestions?: (...params: any) => Suggestion[];
+  suggestions?: (...params: any) => ArgumentSuggestion[];
 }

src/module/suggestion.ts src/module/argumentSuggestion.tssrc/module/suggestion.ts renamed to src/module/argumentSuggestion.ts

@@ -1,4 +1,4 @@
-export default interface Suggestion {
+export default interface ArgumentSuggestion {
   content: string; // what is shown on the suggestion
   icon?: string;
   img?: string;

src/module/commandHandler.ts

@@ -5,10 +5,9 @@ import rawArg from './arguments/rawArg';
 import stringArg from './arguments/stringArg';
 import Command from './command';
 import Argument from './argument';
-import Suggestion from './suggestion';
-import { getSetting, SETTING } from './settings';
+import ArgumentSuggestion from './argumentSuggestion';
 import { getCommandSchemaWithoutArguments } from './utils/commandUtils';
-import { getGame, MODULE_NAME } from './utils/moduleUtils';
+import { getGame, MODULE_NAME, getSetting, SETTING } from './utils/moduleUtils';
 import { ARGUMENT_TYPES, localize } from './utils/moduleUtils';
 
 const argumentMap = new Map<ARGUMENT_TYPES, ArgumentType>();
@@ -23,8 +22,6 @@ export default class CommandHandler {
 
   constructor() {
     this.commandMap = new Map<string, Command>();
-    // console.log(`${MODULE_NAME} | ${localize('Handler.RetrievingCommands')}`);
-    // retrieveCommandsFromModuleSetting().forEach(c => this._register(c, false, true));
   }
 
   get commands(): Command[] {
@@ -47,7 +44,7 @@ export default class CommandHandler {
     }
   };
 
-  suggestArguments = (input: string): Suggestion[] | undefined => {
+  suggestArguments = (input: string): ArgumentSuggestion[] | undefined => {
     if (startsWithOverride(input)) return; // ignore chat rolls
     input = sanitizeInput(input);
     input = removeOrphanQuotes(input);