Skip to content

Commit

Permalink
Add attribution for logo
Browse files Browse the repository at this point in the history
  • Loading branch information
@TranquilMarmot
TranquilMarmot committed Jul 20, 2020
1 parent 8dec3a3 commit 0d595a3
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
20 changes: 11 additions & 9 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,15 +58,17 @@ To contribute to this repo, [fork it](https://docs.github.com/en/github/getting-

### Available scripts

All scripts **must** be run at the root of the repo. Because of the way that Lerna works, most scripts cannot be run directly in sub-projects.

| Command | Description | | | |
| -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --- | --- |
| `build`<br><br>`build:common`<br>`build:editor`<br>`build:extension` | Running `npm run build` will build all sub-projects in the correct order.<br><br>This is what is called when launching the extension. See [`launch.json`](./.vscode/launch.json).<br><br>The other tasks are used to build specific sub-projects. In general, these need to be executed in a specific order for the extension to compile properly: `build:common`, then `build:editor`, then `build:extension`. | | | |
| `test`<br><br>`test:common`<br>`test:editor`<br>`test:extension` | Running `npm test` will run all tests in all sub-projects.<br><br>This sets the environment variable `CI=true`. This is mainly because the `create-react-app` tests usually run in an interactive mode.<br><br>To run the `loom-editor` tests interactively, run the following:<br>`cd loom-editor/ && ../node_modules/.bin/react-scripts test`<br><br>This will re-run tests for changed files in the editor in watch mode. | | | |
| `package` | Running `npm run package` will build and package the extension. This just runs the `package` command in the `loom-extension` project. `build` must be called first. | | | |
| `pretter` | This will run [Prettier](https://prettier.io/) on all files in the project and overwrite them if they need formatting changes. | | | |
| `lint`<br><br>`lint:common`<br>`lint:editor`<br>`lint:extension` | Running `npm run lint` will run [eslint](https://eslint.org/) on all files in all sub-projects, as well as running prettier on all files in check mode (not overwriting them).<br><br>This will fail if any files do not pass lint or have not been formatted with `npm run prettier`. | | | |
All scripts **must** be run at the root of the repo.

Because of the way that [lerna](https://lerna.js.org/) works, most scripts cannot be run directly in sub-projects. See the [Project Layout](#project-layout) section for more information.

| Command | Description |
| -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `build`<br><br>`build:common`<br>`build:editor`<br>`build:extension` | `npm run build` will build all sub-projects in the correct order.<br><br>This is what is called when launching the extension. See [`launch.json`](./.vscode/launch.json).<br><br>The other tasks are used to build specific sub-projects. In general, these need to be executed in a specific order for the extension to compile properly: `build:common`, then `build:editor`, then `build:extension`. |
| `test`<br><br>`test:common`<br>`test:editor`<br>`test:extension` | `npm test` will run all tests in all sub-projects.<br><br>This sets the environment variable `CI=true`. This is mainly because the `create-react-app` tests usually run in an interactive mode.<br><br>To run the `loom-editor` tests interactively, run the following:<br>`cd loom-editor/ && ../node_modules/.bin/react-scripts test`<br><br>This will re-run tests for changed files in the editor in watch mode. |
| `package` | `npm run package` will build and package the extension. This just runs the `package` command in the `loom-extension` project. `build` must be called first. |
| `pretter` | `npm run prettier` will run [Prettier](https://prettier.io/) on all files in the project and overwrite them if they need formatting changes. |
| `lint`<br><br>`lint:common`<br>`lint:editor`<br>`lint:extension` | `npm run lint` will run [eslint](https://eslint.org/) on all files in all sub-projects, as well as running prettier on all files in check mode (not overwriting them).<br><br>This will fail if any files do not pass lint or have not been formatted with `npm run prettier`. |

### CI/CD

Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Yarn Loom Visual Studio Code Extension

<p align="center">
<img src="./images/logo.svg" alt="Yarn Loom Logo" />
</p>
<img src="./images/logo.svg" alt="Yarn Loom Logo" align="right" width="100px" />

Yarn Loom is a Visual Studio Code extension for editing [yarn files](https://yarnspinner.dev/). It is a re-imagining of the [Yarn Editor](https://github.com/YarnSpinnerTool/YarnEditor) built from the ground up to integrate seamlessly with Visual Studio Code.

Expand Down Expand Up @@ -150,3 +148,5 @@ In this menu, clicking the gear icon will set an editor as the default editor fo
The syntax highlighting portion of this extension was copied over from the [Yarn VSCode Extension](https://github.com/YarnSpinnerTool/VSCodeExtension) and all credit for it goes to [@desplesda](https://github.com/desplesda).

Portions of Yarn file parsing and in-editor highlighting were copied over from the [Yarn Editor](https://github.com/YarnSpinnerTool/YarnEditor) and all credit for it goes to the Yarn Editor contributors, but especially [@blurymind](https://github.com/blurymind).

The original [Yarn Spinner logo](https://yarnspinner.dev/img/YarnSpinnerLogo.png) was made by [Cecile Richard](https://www.cecile-richard.com/) and was remixed to create the logo for this extension.

0 comments on commit 0d595a3

Please sign in to comment.