just-task 1.9.0 → 1.10.0

package/CHANGELOG.json

@@ -2,7 +2,37 @@
   "name": "just-task",
   "entries": [
     {
-      "date": "Sat, 02 Mar 2024 02:16:28 GMT",
+      "date": "Tue, 26 Mar 2024 00:12:31 GMT",
+      "version": "1.10.0",
+      "tag": "just-task_v1.10.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "email not defined",
+            "package": "just-task",
+            "commit": "83bfae7bad6e4137a07ec633a5f5c910df1ffe67",
+            "comment": "Update dependency undertaker to v2"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sat, 02 Mar 2024 08:01:34 GMT",
+      "version": "1.9.0",
+      "tag": "just-task_v1.9.0",
+      "comments": {
+        "none": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "just-task",
+            "commit": "feb6217bf318c7d606c6147a4f5d6568572bb2f3",
+            "comment": "Update build setup"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sat, 02 Mar 2024 02:16:34 GMT",
       "version": "1.9.0",
       "tag": "just-task_v1.9.0",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,20 @@
 # Change Log - just-task
 
-This log was last generated on Sat, 02 Mar 2024 02:16:28 GMT and should not be manually modified.
+This log was last generated on Tue, 26 Mar 2024 00:12:31 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 1.10.0
+
+Tue, 26 Mar 2024 00:12:31 GMT
+
+### Minor changes
+
+- Update dependency undertaker to v2 (email not defined)
+
 ## 1.9.0
 
-Sat, 02 Mar 2024 02:16:28 GMT
+Sat, 02 Mar 2024 02:16:34 GMT
 
 ### Minor changes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "just-task",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "Build task definition library",
   "keywords": [],
   "repository": {
@@ -36,7 +36,7 @@
     "fs-extra": "^11.0.0",
     "just-task-logger": ">=1.2.1 <2.0.0",
     "resolve": "^1.19.0",
-    "undertaker": "^1.3.0",
+    "undertaker": "^2.0.0",
     "undertaker-registry": "^2.0.0",
     "yargs-parser": "^20.2.3"
   },

package/api-extractor.json

@@ -1,4 +0,0 @@
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "just-task-scripts/api-extractor.base.json"
-}

package/etc/just-task.api.md

@@ -1,126 +0,0 @@
-## API Report File for "just-task"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-/// <reference types="node" />
-
-import { Arguments } from 'yargs-parser';
-import { Duplex } from 'stream';
-import type { FSWatcher } from 'chokidar';
-import { Logger } from 'just-task-logger';
-import type { Stats } from 'fs';
-import { TaskFunction as TaskFunction_2 } from 'undertaker';
-import { TaskFunctionParams } from 'undertaker';
-import Undertaker = require('undertaker');
-import type { WatchOptions } from 'chokidar';
-
-// @public
-export function addResolvePath(pathName: string): void;
-
-// @public (undocumented)
-export function argv(): Arguments;
-
-// @public (undocumented)
-export function chain(subjectTaskName: string): {
-    before: (taskName: string) => void;
-    after: (taskName: string) => void;
-};
-
-// @public (undocumented)
-export function clearCache(): void;
-
-// @public (undocumented)
-export function condition(taskName: string, conditional: () => boolean): TaskFunction_2;
-
-// Warning: (ae-forgotten-export) The symbol "OptionConfig" needs to be exported by the entry point index.d.ts
-//
-// @public (undocumented)
-export function option(key: string, options?: OptionConfig): void;
-
-// @public (undocumented)
-interface OptionConfig {
-    alias?: string | string[];
-    array?: boolean;
-    boolean?: boolean;
-    coerce?: (arg: any) => any;
-    count?: boolean;
-    default?: any;
-    describe?: string;
-    narg?: number;
-    normalize?: boolean;
-    number?: boolean;
-    string?: boolean;
-}
-
-// @public (undocumented)
-export function parallel(...tasks: Task[]): Undertaker.TaskFunction;
-
-// @public
-export function resetResolvePaths(): void;
-
-// Warning: (ae-forgotten-export) The symbol "ResolveOptions" needs to be exported by the entry point index.d.ts
-//
-// @public
-export function resolve(moduleName: string, options?: ResolveOptions): string | null;
-
-// @public @deprecated
-export function resolve(moduleName: string, cwd?: string): string | null;
-
-// @public
-export function resolveCwd(moduleName: string, options?: ResolveOptions): string | null;
-
-// @public @deprecated
-export function resolveCwd(moduleName: string, cwd?: string): string | null;
-
-// @public (undocumented)
-interface ResolveOptions {
-    cwd?: string;
-    extensions?: string[];
-}
-
-// @public (undocumented)
-export function series(...tasks: Task[]): Undertaker.TaskFunction;
-
-// @public (undocumented)
-export type Task = string | TaskFunction;
-
-// @public (undocumented)
-export function task(firstParam: string | TaskFunction, secondParam?: string | TaskFunction, thirdParam?: TaskFunction): TaskFunction;
-
-// @public (undocumented)
-export interface TaskContext {
-    // (undocumented)
-    argv: Arguments;
-    // (undocumented)
-    logger: Logger;
-}
-
-// @public (undocumented)
-export interface TaskFunction extends TaskFunctionParams {
-    // (undocumented)
-    (this: TaskContext, done: (error?: any) => void): void | Duplex | NodeJS.Process | Promise<never> | any;
-    // (undocumented)
-    cached?: () => void;
-    // (undocumented)
-    description?: string;
-}
-
-// @public (undocumented)
-export const undertaker: Undertaker;
-
-// Warning: (ae-forgotten-export) The symbol "WatchListener" needs to be exported by the entry point index.d.ts
-//
-// @public (undocumented)
-export function watch(globs: string | string[], optionsOrListener?: WatchListener | WatchOptions | undefined, listener?: WatchListener | undefined): FSWatcher;
-
-// @public (undocumented)
-type WatchListener = (path: string, stats?: Stats) => void;
-
-
-export * from "just-task-logger";
-
-// (No @packageDocumentation comment for this package)
-
-```

package/src/__tests__/__mocks__/just-task.js

@@ -1,5 +0,0 @@
-// Dummy
-const { task } = require('../../task');
-module.exports = function () {
-  task('default', () => undefined);
-};

package/src/__tests__/chain.spec.ts

@@ -1,50 +0,0 @@
-import { task } from '../task';
-import { chain } from '../chain';
-import { parallel } from '../undertaker';
-
-describe('chain', () => {
-  it('allows tasks to be injected before another one after definition', done => {
-    const callOrder: number[] = [];
-
-    const test1Function = jest.fn(() => {
-      callOrder.push(1);
-    });
-    const test2Function = jest.fn(() => {
-      callOrder.push(2);
-    });
-
-    task('test1', test1Function);
-    task('test2', test2Function);
-    chain('test2').before('test1');
-
-    parallel('test1')(() => {
-      expect(test2Function).toBeCalledTimes(1);
-      expect(test1Function).toBeCalledTimes(1);
-      expect(callOrder).toEqual([2, 1]);
-      done();
-    });
-  });
-
-  it('allows tasks to be injected after another one', done => {
-    const callOrder: number[] = [];
-
-    const test1Function = jest.fn(() => {
-      callOrder.push(1);
-    });
-    const test2Function = jest.fn(() => {
-      callOrder.push(2);
-    });
-
-    task('test1', test1Function);
-    task('test2', test2Function);
-
-    chain('test2').after('test1');
-
-    parallel('test1')(() => {
-      expect(test2Function).toBeCalledTimes(1);
-      expect(test1Function).toBeCalledTimes(1);
-      expect(callOrder).toEqual([1, 2]);
-      done();
-    });
-  });
-});

package/src/__tests__/resolve.spec.ts

@@ -1,260 +0,0 @@
-import * as path from 'path';
-import {
-  _isFileNameLike,
-  _tryResolve,
-  resetResolvePaths,
-  resolveCwd,
-  addResolvePath,
-  resolve,
-  _getResolvePaths,
-} from '../resolve';
-import * as option from '../option';
-import * as config from '../config';
-import * as mockfs from 'mock-fs';
-
-describe('_isFileNameLike', () => {
-  it('returns false for empty input', () => {
-    expect(_isFileNameLike('')).toBe(false);
-    expect(_isFileNameLike(undefined as any)).toBe(false);
-    expect(_isFileNameLike(null as any)).toBe(false);
-  });
-
-  it('returns true for filenames', () => {
-    expect(_isFileNameLike('.')).toBe(true);
-    expect(_isFileNameLike('.gitignore')).toBe(true);
-    expect(_isFileNameLike('foo.js')).toBe(true);
-  });
-
-  it('returns false for possible non-filenames', () => {
-    expect(_isFileNameLike('foo')).toBe(false);
-  });
-
-  it('returns false for names with separators', () => {
-    expect(_isFileNameLike('foo/bar')).toBe(false);
-    expect(_isFileNameLike('foo\\bar')).toBe(false);
-    expect(_isFileNameLike('foo/bar.txt')).toBe(false);
-    expect(_isFileNameLike('foo\\bar.txt')).toBe(false);
-  });
-});
-
-describe('_tryResolve', () => {
-  afterEach(() => {
-    mockfs.restore();
-  });
-
-  it('does not throw', () => {
-    expect(_tryResolve('foo', { cwd: 'bar' })).toBeNull();
-    expect(_tryResolve(undefined as any, undefined as any)).toBeNull();
-  });
-
-  it('does not recurse into child dirs', () => {
-    mockfs({
-      a: { 'b.txt': '' },
-    });
-    expect(_tryResolve('b.txt', { cwd: process.cwd() })).toBeNull();
-  });
-
-  it('resolves filename relative to basedir', () => {
-    mockfs({
-      a: { 'b.txt': '' }, // right
-      'b.txt': '', // wrong
-    });
-    expect(_tryResolve('b.txt', { cwd: 'a' })).toContain(path.join('a', 'b.txt'));
-  });
-
-  it('resolves non-filename relative to node_modules in basedir', () => {
-    mockfs({
-      a: {
-        'b.js': '', // wrong
-        node_modules: { 'b.js': '' }, // right
-      },
-      node_modules: { 'b.js': '' }, // wrong
-    });
-    expect(_tryResolve('b', { cwd: 'a' })).toContain(path.join('a', 'node_modules', 'b.js'));
-  });
-
-  it('resolves path with /', () => {
-    mockfs({
-      a: { node_modules: { b: { 'c.js': '' } } },
-    });
-    expect(_tryResolve('b/c', { cwd: 'a' })).toContain(path.join('a', 'node_modules', 'b', 'c.js'));
-  });
-});
-
-describe('_getResolvePaths', () => {
-  afterEach(() => {
-    resetResolvePaths();
-  });
-
-  it('uses resolvePaths for before __dirname', () => {
-    jest.spyOn(option, 'argv').mockImplementation(() => ({ config: 'config/just-task.js' } as any));
-    addResolvePath('custom1');
-    addResolvePath('custom2');
-
-    const paths = _getResolvePaths('cwd');
-
-    expect(paths.map(p => path.basename(p))).toEqual(['cwd', 'config', 'custom1', 'custom2', 'src']);
-  });
-});
-
-describe('resolveCwd', () => {
-  beforeEach(() => {
-    jest.spyOn(option, 'argv').mockImplementation(() => ({ config: undefined } as any));
-  });
-
-  afterEach(() => {
-    mockfs.restore();
-    resetResolvePaths();
-  });
-
-  // Not testing this one extensively since it's basically a pass-through to _tryResolve
-
-  it('defaults to searching relative to process cwd', () => {
-    mockfs({
-      a: { 'b.txt': '' }, // right
-      'b.txt': '', // wrong
-    });
-    jest.spyOn(process, 'cwd').mockReturnValueOnce('a');
-    expect(resolveCwd('b.txt')).toContain(path.join('a', 'b.txt'));
-  });
-
-  it('uses provided cwd', () => {
-    mockfs({
-      a: { 'b.txt': '' }, // right
-      'b.txt': '', // wrong
-    });
-    expect(resolveCwd('b.txt', 'a')).toContain(path.join('a', 'b.txt'));
-  });
-
-  it('ignores resolvePaths', () => {
-    mockfs({
-      a: { 'b.txt': '' },
-    });
-    addResolvePath('a');
-    expect(resolveCwd('b.txt')).toBeNull();
-  });
-});
-
-describe('resolve', () => {
-  jest.spyOn(option, 'argv').mockImplementation(() => ({ config: undefined } as any));
-
-  afterEach(() => {
-    mockfs.restore();
-    resetResolvePaths();
-  });
-
-  it('defaults to searching relative to process cwd', () => {
-    mockfs({
-      a: { 'b.txt': '' }, // right
-      'b.txt': '', // wrong
-    });
-    jest.spyOn(process, 'cwd').mockReturnValueOnce('a');
-    expect(resolve('b.txt')).toContain(path.join('a', 'b.txt'));
-  });
-
-  it('uses provided cwd', () => {
-    mockfs({
-      a: { 'b.txt': '' }, // right
-      'b.txt': '', // wrong
-      c: { 'b.txt': '' },
-    });
-    expect(resolve('b.txt', 'a')).toContain(path.join('a', 'b.txt'));
-  });
-
-  it('uses dirname of --config arg', () => {
-    mockfs({
-      a: { 'b.txt': '' },
-    });
-
-    jest.spyOn(option, 'argv').mockImplementation(() => ({ config: 'a/just-task.js' } as any));
-
-    expect(resolve('b.txt')).toContain(path.join('a', 'b.txt'));
-  });
-
-  it('uses resolvePaths for file', () => {
-    mockfs({
-      a: {},
-      c: { 'b.txt': '' },
-    });
-    addResolvePath('a');
-    addResolvePath('c');
-    expect(resolve('b.txt')).toContain(path.join('c', 'b.txt'));
-  });
-
-  it('prefers provided cwd', () => {
-    mockfs({
-      a: { 'b.txt': '' }, // right
-      c: { 'b.txt': '' }, // wrong
-      d: { 'b.txt': '' }, // wrong
-      'b.txt': '', // wrong
-    });
-
-    jest.spyOn(option, 'argv').mockImplementation(() => ({ config: 'a/just-task.js' } as any));
-
-    addResolvePath('c');
-    expect(resolve('b.txt', 'd')).toContain(path.join('d', 'b.txt'));
-  });
-});
-
-describe('resolveConfigFile', () => {
-  afterEach(() => {
-    mockfs.restore();
-    resetResolvePaths();
-  });
-
-  it('default chooses local config', () => {
-    mockfs({
-      config: {
-        'configArgument.ts': 'formConfig',
-        'defaultConfigArgument.ts': 'formDefaultConfig',
-      },
-      'just.config.ts': 'localConfig',
-    });
-    const resolvedConfig = config.resolveConfigFile({ config: undefined, defaultConfig: undefined } as any);
-    expect(resolvedConfig).toContain('just.config.ts');
-  });
-
-  it('config argument wins over local config and defaultConfig', () => {
-    mockfs({
-      config: {
-        'configArgument.ts': 'formConfig',
-        'defaultConfigArgument.ts': 'formDefaultConfig',
-      },
-      'just.config.ts': 'localConfig',
-    });
-    const resolvedConfig = config.resolveConfigFile({
-      config: './config/configArgument.ts',
-      defaultConfig: './config/defaultConfigArgument.ts',
-    } as any);
-    expect(resolvedConfig).toContain('configArgument.ts');
-  });
-
-  it('local config file wins over defaultConfig', () => {
-    mockfs({
-      config: {
-        'configArgument.ts': 'formConfig',
-        'defaultConfigArgument.ts': 'formDefaultConfig',
-      },
-      'just.config.ts': 'localConfig',
-    });
-    const resolvedConfig = config.resolveConfigFile({
-      config: undefined,
-      defaultConfig: './config/defaultConfigArgument.ts',
-    } as any);
-    expect(resolvedConfig).toContain('just.config.ts');
-  });
-
-  it('default config is used as last fallback', () => {
-    mockfs({
-      config: {
-        'configArgument.ts': 'formConfig',
-        'defaultConfigArgument.ts': 'formDefaultConfig',
-      },
-    });
-    const resolvedConfig = config.resolveConfigFile({
-      config: undefined,
-      defaultConfig: './config/defaultConfigArgument.ts',
-    } as any);
-    expect(resolvedConfig).toContain('defaultConfigArgument.ts');
-  });
-});

package/src/__tests__/task.spec.ts

@@ -1,65 +0,0 @@
-import { task } from '../task';
-import { parallel, undertaker } from '../undertaker';
-import { logger } from '../logger';
-import * as path from 'path';
-import * as option from '../option';
-import * as UndertakerRegistry from 'undertaker-registry';
-
-describe('task', () => {
-  beforeAll(() => {
-    jest
-      .spyOn(option, 'argv')
-      .mockImplementation(() => ({ config: path.resolve(__dirname, '__mocks__/just-task.js') } as any));
-    jest.spyOn(logger, 'info').mockImplementation(() => undefined);
-  });
-
-  beforeEach(() => {
-    undertaker.registry(new UndertakerRegistry());
-  });
-
-  afterAll(() => {
-    jest.spyOn(option, 'argv').mockImplementation(() => ({ config: 'a/just-task.js' } as any));
-    jest.restoreAllMocks();
-  });
-
-  it('allows synchronous tasks to be defined and be run', done => {
-    const testFunction = jest.fn(() => undefined);
-
-    task('test', function () {
-      testFunction();
-    });
-
-    parallel('test')(function () {
-      expect(testFunction).toBeCalledTimes(1);
-      done();
-    });
-  });
-
-  it('allows callback-based tasks to be defined and be run', done => {
-    const testFunction = jest.fn(() => undefined);
-
-    task('test', function (cb) {
-      testFunction();
-      cb();
-    });
-
-    parallel('test')(function () {
-      expect(testFunction).toBeCalledTimes(1);
-      done();
-    });
-  });
-
-  it('allows promise-based tasks to be defined and be run', done => {
-    const testFunction = jest.fn(() => undefined);
-
-    task('test', function () {
-      const result = testFunction();
-      return Promise.resolve(result);
-    });
-
-    parallel('test')(function () {
-      expect(testFunction).toBeCalledTimes(1);
-      done();
-    });
-  });
-});

package/src/__tests__/watch.spec.ts

@@ -1,38 +0,0 @@
-import { watch } from '../watch';
-import * as fs from 'fs';
-import * as path from 'path';
-import * as os from 'os';
-
-describe('watch', () => {
-  it('can take a synchronous taskFunction', done => {
-    const tmpDir = path.join(os.tmpdir(), fs.mkdtempSync('watch-sync'));
-    const changeFile = path.join(tmpDir, 'change.txt');
-
-    fs.mkdirSync(tmpDir, { recursive: true });
-    fs.writeFileSync(changeFile, 'to be changed');
-
-    const cleanup = () => {
-      watcher.close();
-
-      fs.unlinkSync(changeFile);
-      fs.rmdirSync(tmpDir);
-    };
-
-    const callback = () => {
-      try {
-        expect(true).toBeTruthy();
-        cleanup();
-        done();
-      } catch (error) {
-        cleanup();
-        done(error);
-      }
-    };
-
-    const watcher = watch([path.join(changeFile)], callback);
-
-    watcher.on('ready', () => {
-      fs.writeFileSync(changeFile, 'new content');
-    });
-  });
-});