8000 Update README.md files and descriptions · clouedoc/rushstack@27140a2 · GitHub
[go: up one dir, main page]
8000
Skip to content

Commit 27140a2

Browse files
octogonzoctogonz
committed
Update README.md files and descriptions
1 parent 0c8d1a8 commit 27140a2

File tree

10 files changed

+30
-47
lines changed

10 files changed

+30
-47
lines changed

‎build-tests-samples/heft-node-basic-tutorial/README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
# heft-node-basic-tutorial
22

3-
This project folder demonstrates a sample configuration of the [Heft](https://www.npmjs.com/package/@rushstack/heft)
4-
build system. It illustrates a minimal realistic small project that targets the Node.js runtime.
3+
This is a copy of the
4+
[heft-node-basic-tutorial](https://github.com/microsoft/rushstack-samples/tree/main/heft/heft-node-basic-tutorial)
5+
tutorial project from the [rushstack-samples](https://github.com/microsoft/rushstack-samples) repo.
56

6-
The following tasks are configured:
7-
- [TypeScript](https://rushstack.io/pages/heft_tasks/typescript/) compiler
8-
- [ESLint](https://rushstack.io/pages/heft_tasks/eslint/) coding style validator
9-
- [Jest](https://rushstack.io/pages/heft_tasks/jest/) test runner
10-
11-
Please see the [Getting started with Heft](https://rushstack.io/pages/heft_tutorials/getting_started/)
12-
article for more information.
7+
The copy here serves as a regression test, by using `"workspace:*"` references to the local projects in this repo.
8+
Please update the copy from time to time to keep it in sync with the official tutorial.

‎build-tests-samples/heft-node-basic-tutorial/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "heft-node-basic-tutorial",
3-
"description": "This project illustrates a minimal tutorial Heft project targeting the Node.js runtime",
3+
"description": "(Copy of sample project) Building this project is a regression test for Heft",
44
"version": "1.0.0",
55
"private": true,
66
"main": "lib/index.js",

‎build-tests-samples/heft-node-jest-tutorial/README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
# heft-node-jest-tutorial
22

3-
This project folder demonstrates a sample configuration of the [Heft](https://www.npmjs.com/package/@rushstack/heft)
4-
build system. It illustrates how various Jest scenarios are handled when using Heft's transform for Jest.
3+
This is a copy of the
4+
[heft-node-jest-tutorial](https://github.com/microsoft/rushstack-samples/tree/main/heft/heft-node-jest-tutorial)
5+
tutorial project from the [rushstack-samples](https://github.com/microsoft/rushstack-samples) repo.
56

6-
The following tasks are configured:
7-
- [TypeScript](https://rushstack.io/pages/heft_tasks/typescript/) compiler
8-
- [ESLint](https://rushstack.io/pages/heft_tasks/eslint/) coding style validator
9-
- [Jest](https://rushstack.io/pages/heft_tasks/jest/) test runner
10-
11-
Please see the [Getting started with Heft](https://rushstack.io/pages/heft_tutorials/getting_started/)
12-
and ["jest" task](https://rushstack.io/pages/heft_tasks/jest/) articles for more information.
7+
The copy here serves as a regression test, by using `"workspace:*"` references to the local projects in this repo.
8+
Please update the copy from time to time to keep it in sync with the official tutorial.

‎build-tests-samples/heft-node-jest-tutorial/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "heft-node-jest-tutorial",
3-
"description": "Building this project validates that various Jest features work correctly with Heft",
3+
"description": "(Copy of sample project) Building this project is a regression test for Heft",
44
"version": "1.0.0",
55
"private": true,
66
"license": "MIT",

‎build-tests-samples/heft-node-rig-tutorial/README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
# heft-node-rig-tutorial
22

3-
This project folder demonstrates a sample configuration of the [Heft](https://www.npmjs.com/package/@rushstack/heft)
4-
build system. It illustrates a minimal realistic small project that targets the Node.js runtime,
5-
and builds using the rig package `@rushstack/heft-node-rig`.
3+
This is a copy of the
4+
[heft-node-rig-tutorial](https://github.com/microsoft/rushstack-samples/tree/main/heft/heft-node-rig-tutorial)
5+
tutorial project from the [rushstack-samples](https://github.com/microsoft/rushstack-samples) repo.
66

7-
The following tasks are configured:
8-
- [TypeScript](https://rushstack.io/pages/heft_tasks/typescript/) compiler
9-
- [ESLint](https://rushstack.io/pages/heft_tasks/eslint/) coding style validator
10-
- [Jest](https://rushstack.io/pages/heft_tasks/jest/) test runner
11-
12-
Please see the [Getting started with Heft](https://rushstack.io/pages/heft_tutorials/getting_started/)
13-
and [Using rigs](https://rushstack.io/pages/heft/rig_packages/) articles for more information.
7+
The copy here serves as a regression test, by using `"workspace:*"` references to the local projects in this repo.
8+
Please update the copy from time to time to keep it in sync with the official tutorial.

‎build-tests-samples/heft-node-rig-tutorial/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "heft-node-rig-tutorial",
3-
"description": "This project illustrates a minimal tutorial Heft project targeting the Node.js runtime and using a rig package",
3+
"description": "(Copy of sample project) Building this project is a regression test for Heft",
44
"version": "1.0.0",
55
"private": true,
66
"main": "lib/index.js",

‎build-tests-samples/heft-webpack-basic-tutorial/README.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,8 @@
11
# heft-webpack-basic-tutorial
22

3-
This project folder demonstrates a sample configuration of the [Heft](https://www.npmjs.com/package/@rushstack/heft)
4-
build system. It illustrates a realistic small project that targets a web browser runtime and renders using
5-
the [React](https://reactjs.org/) library.
3+
This is a copy of the
4+
[heft-webpack-basic-tutorial](https://github.com/microsoft/rushstack-samples/tree/main/heft/heft-webpack-basic-tutorial)
5+
tutorial project from the [rushstack-samples](https://github.com/microsoft/rushstack-samples) repo.
66

7-
The following tasks are configured:
8-
- [TypeScript](https://rushstack.io/pages/heft_tasks/typescript/) compiler
9-
- [ESLint](https://rushstack.io/pages/heft_tasks/eslint/) coding style validator
10-
- [Jest](https://rushstack.io/pages/heft_tasks/jest/) test runner
11-
- [copy-static-assets](https://rushstack.io/pages/heft_tasks/copy-static-assets/) for .css files
12-
- [Webpack](https://rushstack.io/pages/heft_tasks/webpack/) for bundling and optimization
13-
14-
Please see the [Getting started with Heft](https://rushstack.io/pages/heft_tutorials/getting_started/)
15-
and ["webpack" task](https://rushstack.io/pages/heft_tasks/webpack/) articles for more information.
7+
The copy here serves as a regression test, by using `"workspace:*"` references to the local projects in this repo.
8+
Please update the copy from time to time to keep it in sync with the official tutorial.

‎build-tests-samples/heft-webpack-basic-tutorial/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "heft-webpack-basic-tutorial",
3-
"description": "This project illustrates a minimal tutorial Heft project targeting the web browser runtime",
3+
"description": "(Copy of sample project) Building this project is a regression test for Heft",
44
"version": "1.0.0",
55
"private": true,
66
"scripts": {

‎build-tests-samples/packlets-tutorial/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# packlets-tutorial
22

3-
This code sample illustrates how to use "packlet" folders to organize source code within a project.
3+
This is a copy of the
4+
[packlets-tutorial](https://github.com/microsoft/rushstack-samples/tree/main/other/packlets-tutorial)
5+
tutorial project from the [rushstack-samples](https://github.com/microsoft/rushstack-samples) repo.
46

5-
For details, please see the [@rushstack/eslint-plugin-packlets](https://www.npmjs.com/package/@rushstack/eslint-plugin-packlets) documentation.
7+
The copy here serves as a regression test, by using `"workspace:*"` references to the local projects in this repo.
8+
Please update the copy from time to time to keep it in sync with the official tutorial.

‎build-tests-samples/packlets-tutorial/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "packlets-tutorial",
3-
"description": "This project illustrates how to use @rushstack/eslint-plugin-packlets",
3+
"description": "(Copy of sample project) Building this project is a regression test for @rushstack/eslint-plugin-packlets",
44
"version": "1.0.0",
55
"private": true,
66
"license": "MIT",

0 commit comments

Comments
 (0)
0