just-task 1.7.1 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.json CHANGED
@@ -2,7 +2,59 @@
2
2
  "name": "just-task",
3
3
  "entries": [
4
4
  {
5
- "date": "Thu, 09 Mar 2023 08:02:00 GMT",
5
+ "date": "Tue, 12 Sep 2023 08:01:58 GMT",
6
+ "version": "1.8.0",
7
+ "tag": "just-task_v1.8.0",
8
+ "comments": {
9
+ "minor": [
10
+ {
11
+ "author": "elcraig@microsoft.com",
12
+ "package": "just-task",
13
+ "commit": "5b4e7073ffd1f06a7383deccee6883aa7e63342c",
14
+ "comment": "Add `@types` referenced by exports as dependencies"
15
+ }
16
+ ],
17
+ "patch": [
18
+ {
19
+ "author": "email not defined",
20
+ "package": "just-task",
21
+ "commit": "2bc7eaec9203ef96bf1e48823f2f38a3527d24d5",
22
+ "comment": "Update dependency @rushstack/package-deps-hash to v4"
23
+ },
24
+ {
25
+ "author": "renovate@whitesourcesoftware.com",
26
+ "package": "just-task",
27
+ "commit": "e849046a3d1e5c1b4c1a81e12c400391a108323e",
28
+ "comment": "Update dependency fs-extra to v11"
29
+ }
30
+ ],
31
+ "none": [
32
+ {
33
+ "author": "elcraig@microsoft.com",
34
+ "package": "just-task",
35
+ "commit": "06eaab127501104e008ace0c34bd8dfb6d0d2a51",
36
+ "comment": "Unpin dev deps"
37
+ }
38
+ ]
39
+ }
40
+ },
41
+ {
42
+ "date": "Fri, 10 Mar 2023 08:01:53 GMT",
43
+ "tag": "just-task_v1.7.2",
44
+ "version": "1.7.2",
45
+ "comments": {
46
+ "patch": [
47
+ {
48
+ "author": "elcraig@microsoft.com",
49
+ "package": "just-task",
50
+ "commit": "8484242cfb5e360a8de6ac4a1190b5d488034be8",
51
+ "comment": "Update readmes and homepage links"
52
+ }
53
+ ]
54
+ }
55
+ },
56
+ {
57
+ "date": "Thu, 09 Mar 2023 08:02:09 GMT",
6
58
  "tag": "just-task_v1.7.1",
7
59
  "version": "1.7.1",
8
60
  "comments": {
@@ -17,7 +69,7 @@
17
69
  "author": "beachball",
18
70
  "package": "just-task",
19
71
  "comment": "Bump just-task-logger to v1.2.1",
20
- "commit": "8bc1b1bfe6db217824ae979540ee2c775d60be29"
72
+ "commit": "77dab724dfe9e042887caa13e8f2a7e66e33b570"
21
73
  }
22
74
  ]
23
75
  }
package/CHANGELOG.md CHANGED
@@ -1,12 +1,33 @@
1
1
  # Change Log - just-task
2
2
 
3
- This log was last generated on Thu, 09 Mar 2023 08:02:00 GMT and should not be manually modified.
3
+ This log was last generated on Tue, 12 Sep 2023 08:01:58 GMT and should not be manually modified.
4
4
 
5
5
  <!-- Start content -->
6
6
 
7
+ ## 1.8.0
8
+
9
+ Tue, 12 Sep 2023 08:01:58 GMT
10
+
11
+ ### Minor changes
12
+
13
+ - Add `@types` referenced by exports as dependencies (elcraig@microsoft.com)
14
+
15
+ ### Patches
16
+
17
+ - Update dependency @rushstack/package-deps-hash to v4 (email not defined)
18
+ - Update dependency fs-extra to v11 (renovate@whitesourcesoftware.com)
19
+
20
+ ## 1.7.2
21
+
22
+ Fri, 10 Mar 2023 08:01:53 GMT
23
+
24
+ ### Patches
25
+
26
+ - Update readmes and homepage links (elcraig@microsoft.com)
27
+
7
28
  ## 1.7.1
8
29
 
9
- Thu, 09 Mar 2023 08:02:00 GMT
30
+ Thu, 09 Mar 2023 08:02:09 GMT
10
31
 
11
32
  ### Patches
12
33
 
package/README.md CHANGED
@@ -1,61 +1,17 @@
1
- # Just
1
+ # just-task
2
2
 
3
3
  [![npm version](https://badge.fury.io/js/just-task.svg)](https://badge.fury.io/js/just-task)
4
4
  [![NPM Downloads](https://img.shields.io/npm/dm/just-task.svg?style=flat)](https://www.npmjs.com/package/just-task)
5
5
 
6
- `Just` is a library that organizes build tasks for your JS projects. It consists of
6
+ <!-- start shared -->
7
7
 
8
- - a build task definition library
9
- - sane preset build flows for node and browser projects featuring TypeScript, Webpack and jest
8
+ `Just` is a library that organizes build tasks for your JS projects. It consists of:
10
9
 
11
- # Documentation
10
+ - `just-task`: a build task definition library
11
+ - `just-scripts`: sane preset build flows for node and browser projects featuring TypeScript, Webpack and Jest
12
12
 
13
- All the documentation is online at https://microsoft.github.io/just/
14
-
15
- # Building
16
-
17
- This README contains only the instructions on how to build and contribute to the project. This is a monorepo that uses the [lerna](https://github.com/lerna/lerna) monorepo management utility. To get started, simply run the following:
18
-
19
- `yarn`
20
-
21
- and build all the packages this way:
22
-
23
- `yarn build`
24
-
25
- Development is usually done one package at a time. So go into each package and develop with the innerloop npm script:
26
-
27
- ```
28
- cd packages/just-task
29
- yarn dev
30
- ```
13
+ ## Documentation
31
14
 
32
- Tests are run with the `test` npm script:
33
-
34
- ```
35
- cd packages/just-task
36
- yarn test
37
- ```
38
-
39
- # Packages
40
-
41
- | Package | Description |
42
- | ------------------ | --------------------------------------------------------------------------------------- |
43
- | just-task | The task definition library that wraps `undertaker` and `yargs` libraries |
44
- | just-scripts | A reusable preset of frequently used tasks in node and browser projects |
45
- | just-scripts-utils | A set of utilities for `just-scripts` |
46
- | just-task-logger | A shared pretty logger used to display timestamps along with a message |
47
- | documentation | The Docusaurus site content and styles which generates the Github page for this library |
48
-
49
- # Contributing
50
-
51
- This project welcomes contributions and suggestions. Most contributions require you to agree to a
52
- Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
53
- the rights to use your contribution. For details, visit https://cla.microsoft.com. Please refer [Contribution guide](https://github.com/microsoft/just/.github/CONTRIBUTING.md) for more details
54
-
55
- When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
56
- a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
57
- provided by the bot. You will only need to do this once across all repos using our CLA.
15
+ All the documentation is online at https://microsoft.github.io/just/
58
16
 
59
- This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
60
- For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
61
- contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
17
+ <!-- end shared -->
@@ -0,0 +1,4 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
+ "extends": "just-task-scripts/api-extractor.base.json"
4
+ }
@@ -0,0 +1,126 @@
1
+ ## API Report File for "just-task"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ /// <reference types="node" />
8
+
9
+ import { Arguments } from 'yargs-parser';
10
+ import { Duplex } from 'stream';
11
+ import type { FSWatcher } from 'chokidar';
12
+ import { Logger } from 'just-task-logger';
13
+ import type { Stats } from 'fs';
14
+ import { TaskFunction as TaskFunction_2 } from 'undertaker';
15
+ import { TaskFunctionParams } from 'undertaker';
16
+ import Undertaker = require('undertaker');
17
+ import type { WatchOptions } from 'chokidar';
18
+
19
+ // @public
20
+ export function addResolvePath(pathName: string): void;
21
+
22
+ // @public (undocumented)
23
+ export function argv(): Arguments;
24
+
25
+ // @public (undocumented)
26
+ export function chain(subjectTaskName: string): {
27
+ before: (taskName: string) => void;
28
+ after: (taskName: string) => void;
29
+ };
30
+
31
+ // @public (undocumented)
32
+ export function clearCache(): void;
33
+
34
+ // @public (undocumented)
35
+ export function condition(taskName: string, conditional: () => boolean): TaskFunction_2;
36
+
37
+ // Warning: (ae-forgotten-export) The symbol "OptionConfig" needs to be exported by the entry point index.d.ts
38
+ //
39
+ // @public (undocumented)
40
+ export function option(key: string, options?: OptionConfig): void;
41
+
42
+ // @public (undocumented)
43
+ interface OptionConfig {
44
+ alias?: string | string[];
45
+ array?: boolean;
46
+ boolean?: boolean;
47
+ coerce?: (arg: any) => any;
48
+ count?: boolean;
49
+ default?: any;
50
+ describe?: string;
51
+ narg?: number;
52
+ normalize?: boolean;
53
+ number?: boolean;
54
+ string?: boolean;
55
+ }
56
+
57
+ // @public (undocumented)
58
+ export function parallel(...tasks: Task[]): Undertaker.TaskFunction;
59
+
60
+ // @public
61
+ export function resetResolvePaths(): void;
62
+
63
+ // Warning: (ae-forgotten-export) The symbol "ResolveOptions" needs to be exported by the entry point index.d.ts
64
+ //
65
+ // @public
66
+ export function resolve(moduleName: string, options?: ResolveOptions): string | null;
67
+
68
+ // @public @deprecated
69
+ export function resolve(moduleName: string, cwd?: string): string | null;
70
+
71
+ // @public
72
+ export function resolveCwd(moduleName: string, options?: ResolveOptions): string | null;
73
+
74
+ // @public @deprecated
75
+ export function resolveCwd(moduleName: string, cwd?: string): string | null;
76
+
77
+ // @public (undocumented)
78
+ interface ResolveOptions {
79
+ cwd?: string;
80
+ extensions?: string[];
81
+ }
82
+
83
+ // @public (undocumented)
84
+ export function series(...tasks: Task[]): Undertaker.TaskFunction;
85
+
86
+ // @public (undocumented)
87
+ export type Task = string | TaskFunction;
88
+
89
+ // @public (undocumented)
90
+ export function task(firstParam: string | TaskFunction, secondParam?: string | TaskFunction, thirdParam?: TaskFunction): TaskFunction;
91
+
92
+ // @public (undocumented)
93
+ export interface TaskContext {
94
+ // (undocumented)
95
+ argv: Arguments;
96
+ // (undocumented)
97
+ logger: Logger;
98
+ }
99
+
100
+ // @public (undocumented)
101
+ export interface TaskFunction extends TaskFunctionParams {
102
+ // (undocumented)
103
+ (this: TaskContext, done: (error?: any) => void): void | Duplex | NodeJS.Process | Promise<never> | any;
104
+ // (undocumented)
105
+ cached?: () => void;
106
+ // (undocumented)
107
+ description?: string;
108
+ }
109
+
110
+ // @public (undocumented)
111
+ export const undertaker: Undertaker;
112
+
113
+ // Warning: (ae-forgotten-export) The symbol "WatchListener" needs to be exported by the entry point index.d.ts
114
+ //
115
+ // @public (undocumented)
116
+ export function watch(globs: string | string[], optionsOrListener?: WatchListener | WatchOptions | undefined, listener?: WatchListener | undefined): FSWatcher;
117
+
118
+ // @public (undocumented)
119
+ type WatchListener = (path: string, stats?: Stats) => void;
120
+
121
+
122
+ export * from "just-task-logger";
123
+
124
+ // (No @packageDocumentation comment for this package)
125
+
126
+ ```
package/package.json CHANGED
@@ -1,12 +1,13 @@
1
1
  {
2
2
  "name": "just-task",
3
- "version": "1.7.1",
3
+ "version": "1.8.0",
4
4
  "description": "Build task definition library",
5
5
  "keywords": [],
6
6
  "repository": {
7
7
  "type": "git",
8
8
  "url": "https://github.com/microsoft/just"
9
9
  },
10
+ "homepage": "https://microsoft.github.io/just/",
10
11
  "license": "MIT",
11
12
  "author": "Ken Chau <kchau@microsoft.com>",
12
13
  "main": "lib/index.js",
@@ -14,6 +15,8 @@
14
15
  "just": "bin/just.js"
15
16
  },
16
17
  "scripts": {
18
+ "api": "api-extractor run",
19
+ "api:update": "api-extractor run --local",
17
20
  "build": "tsc",
18
21
  "start": "tsc -w --preserveWatchOutput",
19
22
  "start-test": "jest --watch",
@@ -23,22 +26,23 @@
23
26
  "node": ">=14"
24
27
  },
25
28
  "dependencies": {
26
- "@rushstack/package-deps-hash": "^3.2.5",
29
+ "@rushstack/package-deps-hash": "^4.0.0",
30
+ "@types/chokidar": "^2.1.3",
31
+ "@types/undertaker": "^1.2.8",
32
+ "@types/yargs-parser": "^20.2.2",
27
33
  "bach": "^2.0.0",
28
34
  "chalk": "^4.0.0",
29
- "fs-extra": "^10.0.0",
35
+ "chokidar": "^3.5.2",
36
+ "fs-extra": "^11.0.0",
30
37
  "just-task-logger": ">=1.2.1 <2.0.0",
31
38
  "resolve": "^1.19.0",
32
39
  "undertaker": "^1.3.0",
33
40
  "undertaker-registry": "^2.0.0",
34
- "yargs-parser": "^20.2.3",
35
- "chokidar": "^3.5.2"
41
+ "yargs-parser": "^20.2.3"
36
42
  },
37
43
  "devDependencies": {
38
- "@types/chokidar": "2.1.3",
39
- "@types/resolve": "1.20.2",
40
- "@types/undertaker": "1.2.8",
41
- "@types/undertaker-registry": "1.0.1"
44
+ "@types/resolve": "^1.20.2",
45
+ "@types/undertaker-registry": "^1.0.1"
42
46
  },
43
47
  "typing": "lib/index.d.ts"
44
48
  }