feat: expose current version in CLI with --version/-V

dist/commands/benefits.js

@@ -3,9 +3,11 @@ import Table from 'cli-table';
 import { actionRunner } from '../utils.js';
 import { getAccessToken } from '../config.js';
 import { getBenefits } from '../forma.js';
+import VERSION from '../version.js';
 const command = new commander.Command();
 command
     .name('benefits')
+    .version(VERSION)
     .description('List benefits in your Forma account and their remaining balances')
     .option('--access-token <access_token>', 'Access token used to authenticate with Forma')
     .action(actionRunner(async (opts) => {

dist/commands/categories.js

@@ -3,9 +3,11 @@ import Table from 'cli-table';
 import { actionRunner } from '../utils.js';
 import { getAccessToken } from '../config.js';
 import { getCategoriesForBenefitName } from '../forma.js';
+import VERSION from '../version.js';
 const command = new commander.Command();
 command
     .name('categories')
+    .version(VERSION)
     .description('List categories available for a Forma benefit')
     .requiredOption('--benefit <benefit>', 'The benefit to list categories for')
     .option('--access-token <access_token>', 'Access token used to authenticate with Forma')

dist/commands/generate-template-csv.js

@@ -2,10 +2,12 @@ import * as commander from 'commander';
 import { existsSync, writeFileSync } from 'fs';
 import chalk from 'chalk';
 import { actionRunner } from '../utils.js';
+import VERSION from '../version.js';
 const command = new commander.Command();
 const TEMPLATE_CSV = `benefit,category,merchant,amount,description,purchaseDate,receiptPath\n`;
 command
     .name('generate-template-csv')
+    .version(VERSION)
     .description('Generate a template CSV for submitting multiple claims at the same time')
     .option('--output-path <output_path>', 'The path to write the CSV to', 'claims.csv')
     .action(actionRunner(async (opts) => {

dist/commands/login.js

@@ -3,6 +3,7 @@ import chalk from 'chalk';
 import { actionRunner, prompt } from '../utils.js';
 import { setAccessToken } from '../config.js';
 import { exchangeIdAndTkForAccessToken, requestMagicLink } from '../forma.js';
+import VERSION from '../version.js';
 const command = new commander.Command();
 const parseEmailedFormaMagicLink = (input) => {
     const parsedUrl = new URL(input);
@@ -57,6 +58,7 @@ const promptForEmailedMagicLink = (email, errorMessage = null) => {
 };
 command
     .name('login')
+    .version(VERSION)
     .description('Connect Formanator to your Forma account with a magic link')
     .option('--email <email>', 'Email address used to log in to Forma')
     .action(actionRunner(async (opts) => {

dist/commands/submit-claim.js

@@ -5,6 +5,7 @@ import { actionRunner, prompt } from '../utils.js';
 import { getAccessToken } from '../config.js';
 import { createClaim, getBenefitsWithCategories, } from '../forma.js';
 import { claimParamsToCreateClaimOptions } from '../claims.js';
+import VERSION from '../version.js';
 const command = new commander.Command();
 const generateOpenaiPrompt = (opts) => {
     const { description, merchant, validCategories } = opts;
@@ -52,6 +53,7 @@ const attemptToinferCategoryAndBenefit = async (opts) => {
 };
 command
     .name('submit-claim')
+    .version(VERSION)
     .description('Submit a claim for a Forma benefit')
     .option('--benefit <benefit>', 'The benefit you are claiming for. You may omit this if an OpenAI API key is configured')
     .requiredOption('--amount <amount>', 'The amount of the claim')

dist/commands/submit-claims-from-csv.js

@@ -6,6 +6,7 @@ import { actionRunner, serializeError } from '../utils.js';
 import { getAccessToken } from '../config.js';
 import { createClaim } from '../forma.js';
 import { claimParamsToCreateClaimOptions } from '../claims.js';
+import VERSION from '../version.js';
 const command = new commander.Command();
 const EXPECTED_HEADERS = [
     'category',
@@ -37,6 +38,7 @@ const readClaimsFromCsv = async (inputPath) => {
 };
 command
     .name('submit-claims-from-csv')
+    .version(VERSION)
     .description('Submit multiple Forms claims from a CSV. To generate a template CSV to fill in, use the `generate-template-csv` command.')
     .requiredOption('--input-path <input_path>', 'The path to the CSV to read claims from')
     .option('--access-token <access_token>', 'Access token used to authenticate with Forma')

dist/index.js

@@ -6,8 +6,10 @@ import categories from './commands/categories.js';
 import submitClaim from './commands/submit-claim.js';
 import generateTemplateCsv from './commands/generate-template-csv.js';
 import submitClaimsFromCsv from './commands/submit-claims-from-csv.js';
+import VERSION from './version.js';
 const program = new commander.Command();
 program
+    .version(VERSION)
     .addCommand(login)
     .addCommand(benefits)
     .addCommand(categories)

dist/version.js

@@ -0,0 +1,2 @@
+// WARNING: This file will be overwritten with the correct version during the package release process.
+export default '0.0.0-development';

package.json

@@ -8,6 +8,7 @@
   "scripts": {
     "build": "npx tsc -p tsconfig.json",
     "prepublish": "npm run build",
+    "prepack": "node script/generate-version-file.cjs > dist/version.js",
     "lint": "eslint . --ext .ts",
     "lint-and-fix": "eslint . --ext .ts --fix",
     "semantic-release": "semantic-release",

script/generate-version-file.cjs

@@ -0,0 +1,3 @@
+const PACKAGE_VERSION = require('../package.json').version;
+
+console.log(`export default '${PACKAGE_VERSION}'`);

src/commands/benefits.ts

@@ -4,6 +4,7 @@ import Table from 'cli-table';
 import { actionRunner } from '../utils.js';
 import { getAccessToken } from '../config.js';
 import { getBenefits } from '../forma.js';
+import VERSION from '../version.js';
 
 const command = new commander.Command();
 
@@ -13,6 +14,7 @@ interface Arguments {
 
 command
   .name('benefits')
+  .version(VERSION)
   .description('List benefits in your Forma account and their remaining balances')
   .option('--access-token <access_token>', 'Access token used to authenticate with Forma')
   .action(

src/commands/categories.ts

@@ -4,6 +4,7 @@ import Table from 'cli-table';
 import { actionRunner } from '../utils.js';
 import { getAccessToken } from '../config.js';
 import { getCategoriesForBenefitName } from '../forma.js';
+import VERSION from '../version.js';
 
 const command = new commander.Command();
 
@@ -14,6 +15,7 @@ interface Arguments {
 
 command
   .name('categories')
+  .version(VERSION)
   .description('List categories available for a Forma benefit')
   .requiredOption('--benefit <benefit>', 'The benefit to list categories for')
   .option('--access-token <access_token>', 'Access token used to authenticate with Forma')

src/commands/generate-template-csv.ts

@@ -3,6 +3,7 @@ import { existsSync, writeFileSync } from 'fs';
 import chalk from 'chalk';
 
 import { actionRunner } from '../utils.js';
+import VERSION from '../version.js';
 
 const command = new commander.Command();
 
@@ -14,6 +15,7 @@ const TEMPLATE_CSV = `benefit,category,merchant,amount,description,purchaseDate,
 
 command
   .name('generate-template-csv')
+  .version(VERSION)
   .description('Generate a template CSV for submitting multiple claims at the same time')
   .option('--output-path <output_path>', 'The path to write the CSV to', 'claims.csv')
   .action(

src/commands/login.ts

@@ -4,6 +4,7 @@ import chalk from 'chalk';
 import { actionRunner, prompt } from '../utils.js';
 import { setAccessToken } from '../config.js';
 import { exchangeIdAndTkForAccessToken, requestMagicLink } from '../forma.js';
+import VERSION from '../version.js';
 
 const command = new commander.Command();
 
@@ -87,6 +88,7 @@ const promptForEmailedMagicLink = (
 
 command
   .name('login')
+  .version(VERSION)
   .description('Connect Formanator to your Forma account with a magic link')
   .option('--email <email>', 'Email address used to log in to Forma')
   .action(

src/commands/submit-claim.ts

@@ -10,6 +10,7 @@ import {
   getBenefitsWithCategories,
 } from '../forma.js';
 import { claimParamsToCreateClaimOptions } from '../claims.js';
+import VERSION from '../version.js';
 
 const command = new commander.Command();
 
@@ -114,6 +115,7 @@ const attemptToinferCategoryAndBenefit = async (opts: {
 
 command
   .name('submit-claim')
+  .version(VERSION)
   .description('Submit a claim for a Forma benefit')
   .option(
     '--benefit <benefit>',

src/commands/submit-claims-from-csv.ts

@@ -7,6 +7,7 @@ import { actionRunner, serializeError } from '../utils.js';
 import { getAccessToken } from '../config.js';
 import { createClaim } from '../forma.js';
 import { type Claim, claimParamsToCreateClaimOptions } from '../claims.js';
+import VERSION from '../version.js';
 
 const command = new commander.Command();
 
@@ -56,6 +57,7 @@ const readClaimsFromCsv = async (inputPath: string): Promise<Claim[]> => {
 
 command
   .name('submit-claims-from-csv')
+  .version(VERSION)
   .description(
     'Submit multiple Forms claims from a CSV. To generate a template CSV to fill in, use the `generate-template-csv` command.',
   )

src/index.ts

@@ -8,10 +8,12 @@ import categories from './commands/categories.js';
 import submitClaim from './commands/submit-claim.js';
 import generateTemplateCsv from './commands/generate-template-csv.js';
 import submitClaimsFromCsv from './commands/submit-claims-from-csv.js';
+import VERSION from './version.js';
 
 const program = new commander.Command();
 
 program
+  .version(VERSION)
   .addCommand(login)
   .addCommand(benefits)
   .addCommand(categories)

src/version.ts

@@ -0,0 +1,2 @@
+// WARNING: This file will be overwritten with the correct version during the package release process.
+export default '0.0.0-development';