From 0a24fcc4df42ace3577a822db3043f218a0e7b3c Mon Sep 17 00:00:00 2001 From: metonym Date: Thu, 11 Apr 2024 11:08:45 -0700 Subject: [PATCH] docs: update README --- CONTRIBUTING.md | 16 ++++++++-------- README.md | 18 +++++++++--------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 093f0af7..5e015400 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,24 +31,24 @@ yarn install ### Unit tests -Ensure the unit tests pass by running `yarn test:unit`. +Ensure the unit tests pass by running `yarn test`. -### Integration tests +### End-to-end (e2e) tests -Because this library is written in TypeScript, it must be transpiled to JavaScript before it can be used by integration tests in the `integration` folder. +Because this library is written in TypeScript, it must be transpiled to JavaScript before it can be used by e2e tests in the `tests/e2e` folder. Run `yarn build` to build the library. The transpiled JavaScript code is emitted to the `lib` folder. -To build the library in watch mode, run `yarn build:watch`. +To build the library in watch mode, run `yarn build -w`. ### Continuous Integration -The `yarn prepack` command is executed in Travis CI. +This project uses GitHub Actions for continuous integration (CI). It does the following: 1. Build the library -2. Run unit/svelte-check/integration tests in parallel +2. Run unit tests The CI should pass if no unexpected errors occur. @@ -60,8 +60,8 @@ Before submitting a pull request, make sure your fork is up to date with the lat ```sh git fetch upstream -git checkout master -git merge upstream/master +git checkout main +git merge upstream/main ``` ### Submit a PR diff --git a/README.md b/README.md index a71b3076..3679f289 100644 --- a/README.md +++ b/README.md @@ -188,15 +188,15 @@ sveld({ }) ``` -The [integration](integration) folder contains example set-ups: - -- [single-export](integration/single-export): library that exports one component -- [single-export-default-only](integration/single-export-default-only): library that exports one component using the concise `export { default } ...` syntax -- [multi-export](integration/multi-export): multi-component library without JSDoc annotations (types are inferred) -- [multi-export-typed](integration/multi-export-typed): multi-component library with JSDoc annotations -- [multi-export-typed-ts-only](integration/multi-export-typed-ts-only): multi-component library that only generates TS definitions -- [glob](integration/glob): library that uses the glob strategy to collect/analyze \*.svelte files -- [carbon](integration/carbon): full `carbon-components-svelte` example +The [tests/e2e](tests/e2e) folder contains example set-ups: + +- [single-export](tests/e2e/single-export): library that exports one component +- [single-export-default-only](tests/e2e/single-export-default-only): library that exports one component using the concise `export { default } ...` syntax +- [multi-export](tests/e2e/multi-export): multi-component library without JSDoc annotations (types are inferred) +- [multi-export-typed](tests/e2e/multi-export-typed): multi-component library with JSDoc annotations +- [multi-export-typed-ts-only](tests/e2e/multi-export-typed-ts-only): multi-component library that only generates TS definitions +- [glob](tests/e2e/glob): library that uses the glob strategy to collect/analyze \*.svelte files +- [carbon](tests/e2e/carbon): full `carbon-components-svelte` example ### CLI