diff --git a/change/change-2bd96408-6bcd-4ab0-b1d7-2767b3bc3a2e.json b/change/change-2bd96408-6bcd-4ab0-b1d7-2767b3bc3a2e.json new file mode 100644 index 00000000..27e46e22 --- /dev/null +++ b/change/change-2bd96408-6bcd-4ab0-b1d7-2767b3bc3a2e.json @@ -0,0 +1,32 @@ +{ + "changes": [ + { + "type": "none", + "comment": "Update build setup", + "packageName": "just-scripts-utils", + "email": "elcraig@microsoft.com", + "dependentChangeType": "none" + }, + { + "type": "none", + "comment": "Update build setup", + "packageName": "just-scripts", + "email": "elcraig@microsoft.com", + "dependentChangeType": "none" + }, + { + "type": "none", + "comment": "Update build setup", + "packageName": "just-task-logger", + "email": "elcraig@microsoft.com", + "dependentChangeType": "none" + }, + { + "type": "none", + "comment": "Update build setup", + "packageName": "just-task", + "email": "elcraig@microsoft.com", + "dependentChangeType": "none" + } + ] +} \ No newline at end of file diff --git a/docs/scripts/README.md b/docs/scripts/README.md index 41b0f143..436165fd 100644 --- a/docs/scripts/README.md +++ b/docs/scripts/README.md @@ -8,10 +8,10 @@ Unlike other build libraries, Just strives to be useful from the beginning. You > NOTE: even though `just-scripts` interacts with `typescript`, it does not take `typescript` as a dependency. It assumes that the developers will include that in their own projects. This gives `just-scripts` the flexibility of targeting many different versions of individual build tools without imposing a version on the consumers. -These scripts are coded as higher order task functions. Each of these script functions return a task function to be registered as a task in your own `just-task.js` like this: +These scripts are coded as higher order task functions. Each of these script functions return a task function to be registered as a task in your own `just.config.js` like this: ```ts -// just-task.js +// just.config.js import { tscTask } from 'just-scripts'; task('ts', tscTask()); ``` @@ -19,7 +19,7 @@ task('ts', tscTask()); Generally, these higher order functions also take an `options` argument to generate a specific task function preconfigured according to the options. For example: ```ts -// just-task.js +// just.config.js import { tscTask } from 'just-scripts'; task('ts:commonjs', tscTask({ module: 'commonjs' })); task('ts:esnext', tscTask({ module: 'esnext' })); diff --git a/docs/scripts/jest.md b/docs/scripts/jest.md index 638384fa..91cdce5d 100644 --- a/docs/scripts/jest.md +++ b/docs/scripts/jest.md @@ -7,7 +7,7 @@ sidebar_label: Jest Jest is one of the most popular testing libraries in the Javascript ecosystem. It is also a preset supported out of the box inside the `just-scripts` library. Similar to the other presets, this task function assumes that you have a `jest.config.js` at the root of the project. ```tsx -// just-task.js +// just.config.js import { jestTask } from 'just-scripts'; task('test', jestTask()); ``` @@ -15,7 +15,7 @@ task('test', jestTask()); You can pass in a few options like any another preset tasks in the `just-scripts` library. ```tsx -// just-task.js +// just.config.js import { jestTask } from 'just-scripts'; const options = { diff --git a/docs/scripts/lint.md b/docs/scripts/lint.md index 669c5a85..ca47570c 100644 --- a/docs/scripts/lint.md +++ b/docs/scripts/lint.md @@ -7,7 +7,7 @@ sidebar_label: TypeScript Lint TypeScript is a very popular compiler. But as the amount of code grows, developers need a way to keep the code looking consistent. `tslint` is the de facto linter for TS code. ```tsx -// just-task.js +// just.config.js import { tslintTask } from 'just-scripts'; task('tslint', tslintTask()); ``` diff --git a/docs/scripts/typescript.md b/docs/scripts/typescript.md index 527db510..4f639c55 100644 --- a/docs/scripts/typescript.md +++ b/docs/scripts/typescript.md @@ -11,7 +11,7 @@ Given a library with TypeScript source code, it might be desirable to have multi A list of available options are located at the [TypeScript documentation site](http://www.typescriptlang.org/docs/handbook/compiler-options.html). The options passed into the preset function will be passed in as command line arguments as a string. ```tsx -// just-task.js +// just.config.js import { tscTask } from 'just-scripts'; task('ts', tscTask()); ``` @@ -19,7 +19,7 @@ task('ts', tscTask()); For variety, try having two kinds of output at the same time (built in parallel) ```tsx -// just-task.js +// just.config.js import { parallel } from 'just-task'; import { tscTask } from 'just-scripts'; task('ts:commonjs', tscTask({ module: 'commonjs' })); diff --git a/docs/tasks/condition.md b/docs/tasks/condition.md index 9ee9920b..cc98b50c 100644 --- a/docs/tasks/condition.md +++ b/docs/tasks/condition.md @@ -4,7 +4,7 @@ title: Controlling Task Flow with Conditionals sidebar_label: Conditionals --- -Sometimes a `just-task.js` includes tasks that are skipped depending on the arguments that are given. Use a `condition()` function to decide to run a task or to skip it. +Sometimes a `just.config.js` includes tasks that are skipped depending on the arguments that are given. Use a `condition()` function to decide to run a task or to skip it. ## Running tasks in a series diff --git a/packages/just-scripts-utils/.npmignore b/packages/just-scripts-utils/.npmignore index 442eb9e3..e5cc9f63 100644 --- a/packages/just-scripts-utils/.npmignore +++ b/packages/just-scripts-utils/.npmignore @@ -1,2 +1,9 @@ +__tests__ +*.log +*.tgz +api-extractor.json CHANGELOG.* -__tests__ \ No newline at end of file +etc/ +jest.config.js +package-deps.json +tsconfig.json \ No newline at end of file diff --git a/packages/just-scripts-utils/tsconfig.json b/packages/just-scripts-utils/tsconfig.json index 1cf91ac7..1b551f4e 100644 --- a/packages/just-scripts-utils/tsconfig.json +++ b/packages/just-scripts-utils/tsconfig.json @@ -3,6 +3,5 @@ "compilerOptions": { "outDir": "lib" }, - "include": ["src"], - "exclude": ["**/__tests__/**"] + "include": ["src"] } diff --git a/packages/just-scripts/.npmignore b/packages/just-scripts/.npmignore index d437bb37..e5cc9f63 100644 --- a/packages/just-scripts/.npmignore +++ b/packages/just-scripts/.npmignore @@ -1,6 +1,9 @@ -CHANGELOG.* -*.tgz +__tests__ *.log -package-deps.json +*.tgz +api-extractor.json +CHANGELOG.* +etc/ jest.config.js +package-deps.json tsconfig.json \ No newline at end of file diff --git a/packages/just-scripts/config/apiExtractor/api-extractor.json b/packages/just-scripts/config/apiExtractor/api-extractor.json deleted file mode 100644 index 9acfa2b5..00000000 --- a/packages/just-scripts/config/apiExtractor/api-extractor.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", - "mainEntryPointFilePath": "/lib/index.d.ts", - "docModel": { - "enabled": true - }, - "dtsRollup": { - "enabled": true - }, - "apiReport": { - "enabled": true - } -} diff --git a/packages/just-scripts/tsconfig.json b/packages/just-scripts/tsconfig.json index 439a191c..11c2edbd 100644 --- a/packages/just-scripts/tsconfig.json +++ b/packages/just-scripts/tsconfig.json @@ -4,6 +4,5 @@ "outDir": "lib", "sourceMap": true }, - "include": ["src", "typings/*.d.ts"], - "exclude": ["**/__tests__/**"] + "include": ["src"] } diff --git a/packages/just-task-logger/.npmignore b/packages/just-task-logger/.npmignore index 442eb9e3..e5cc9f63 100644 --- a/packages/just-task-logger/.npmignore +++ b/packages/just-task-logger/.npmignore @@ -1,2 +1,9 @@ +__tests__ +*.log +*.tgz +api-extractor.json CHANGELOG.* -__tests__ \ No newline at end of file +etc/ +jest.config.js +package-deps.json +tsconfig.json \ No newline at end of file diff --git a/packages/just-task-logger/tsconfig.json b/packages/just-task-logger/tsconfig.json index 1cf91ac7..1b551f4e 100644 --- a/packages/just-task-logger/tsconfig.json +++ b/packages/just-task-logger/tsconfig.json @@ -3,6 +3,5 @@ "compilerOptions": { "outDir": "lib" }, - "include": ["src"], - "exclude": ["**/__tests__/**"] + "include": ["src"] } diff --git a/packages/just-task/.npmignore b/packages/just-task/.npmignore index d437bb37..e5cc9f63 100644 --- a/packages/just-task/.npmignore +++ b/packages/just-task/.npmignore @@ -1,6 +1,9 @@ -CHANGELOG.* -*.tgz +__tests__ *.log -package-deps.json +*.tgz +api-extractor.json +CHANGELOG.* +etc/ jest.config.js +package-deps.json tsconfig.json \ No newline at end of file diff --git a/packages/just-task/tsconfig.json b/packages/just-task/tsconfig.json index 0762cc07..1b551f4e 100644 --- a/packages/just-task/tsconfig.json +++ b/packages/just-task/tsconfig.json @@ -3,6 +3,5 @@ "compilerOptions": { "outDir": "lib" }, - "include": ["src", "types"], - "exclude": ["**/__tests__/**"] + "include": ["src"] }