Skip to content

Commit

Permalink
fix formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
davidsemakula committed Feb 4, 2024
1 parent c521f16 commit f9e21fe
Show file tree
Hide file tree
Showing 10 changed files with 199 additions and 77 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ jobs:
npm_config_arch: ${{ matrix.npm-config-arch }}
run: yarn install --frozen-lockfile

# Auto-downloads the platform specific language server (see https://github.com/ink-analyzer/ink-vscode/blob/master/setup.js).
# Auto-downloads the platform specific language server
# (see https://github.com/ink-analyzer/ink-vscode/blob/master/setup.js).
- name: Build packages
env:
npm_config_arch: ${{ matrix.npm-config-arch }}
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ jobs:
- name: Run lints
run: yarn lint

# Auto-downloads the platform specific language server (see https://github.com/ink-analyzer/ink-vscode/blob/master/setup.js).
# Auto-downloads the platform specific language server
# (see https://github.com/ink-analyzer/ink-vscode/blob/master/setup.js).
- name: Run tests (Windows and macOS)
if: inputs.os != 'ubuntu-latest'
env:
Expand Down
37 changes: 23 additions & 14 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,18 @@
- [Node.js >= 16.0](https://nodejs.org/)
- [Yarn >= 1.0](https://yarnpkg.com/)

**NOTE:** Older versions of Node.js and Yarn may work, however, they have not been tested and no support will be provided for them.
Similarly other package managers (e.g. [npm](https://www.npmjs.com/) and [pnpm](https://pnpm.io/)) will likely work, but they haven't been tested and no support will be provided for them.
**NOTE:** Older versions of Node.js and Yarn may work, however, they have not been tested and no support will be
provided for them. Similarly other package managers (e.g. [npm](https://www.npmjs.com/) and [pnpm](https://pnpm.io/))
will likely work, but they haven't been tested and no support will be provided for them.

### Dev Container Development

- [Visual Studio Code](https://code.visualstudio.com/)
- [Docker](https://www.docker.com/)
- [Dev Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)

Follow these VS Code Dev Containers tutorials to set up your development environment and get started with container-based development:
Follow these VS Code Dev Containers tutorials to set up your development environment and get started with
container-based development:

- [Dev Containers tutorial](https://code.visualstudio.com/docs/devcontainers/tutorial)
- [Developing inside a Container](https://code.visualstudio.com/docs/devcontainers/containers)
Expand Down Expand Up @@ -45,19 +47,26 @@ Run the following command from the project root:
yarn install
```

**NOTE:** The above command is automatically run after the Dev Container is created, so it can be skipped in that context.
**NOTE:** The above command is automatically run after a Dev Container is created, so it can be skipped in that context.

### Debugging

- Open the project in VS Code.
- Start a debugging session using either the `Run Extension (alongside Rust Analyzer)` or `Run Extension (without Rust Analyzer)` launch configuration.
- This will open a new VS Code window with the extension loaded and the [`test-fixtures`](/test-fixtures) directory set as the workspace root.
- Start a debugging session using either the `Run Extension (alongside Rust Analyzer)` or
`Run Extension (without Rust Analyzer)` launch configuration.
- This will open a new VS Code window with the extension loaded and the [`test-fixtures`](/test-fixtures) directory
set as the workspace root.
- A debugging session can be started in a few ways including:
- Opening the ["Run and Debug" view](https://code.visualstudio.com/docs/editor/debugging#_run-and-debug-view) and selecting and running the preferred launch configuration from the configuration dropdown.
- Selecting `Start Debugging > Run Extension (alongside Rust Analyzer)` or `Start Debugging > Run Extension (without Rust Analyzer)` from the ["Command Palette"](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
- Selecting `Run > Start Debugging` from the [application menu](https://code.visualstudio.com/docs/editor/debugging#_run-menu) to run the last run (or default) Debug configuration.
- Opening the ["Run and Debug" view](https://code.visualstudio.com/docs/editor/debugging#_run-and-debug-view) and
selecting and running the preferred launch configuration from the configuration dropdown.
- Selecting `Start Debugging > Run Extension (alongside Rust Analyzer)` or
`Start Debugging > Run Extension (without Rust Analyzer)` from the
["Command Palette"](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
- Selecting `Run > Start Debugging` from the [application menu](https://code.visualstudio.com/docs/editor/debugging#_run-menu)
to run the last run (or default) Debug configuration.

**NOTE:** Extension source code is found in the [`src/`](/src) directory and [`src/extension.ts`](/src/extension.ts) is the entrypoint.
**NOTE:** Extension source code is found in the [`src/`](/src) directory and [`src/extension.ts`](/src/extension.ts)
is the entrypoint.

## Testing

Expand All @@ -76,7 +85,8 @@ yarn test
- Open the project in VS Code.
- Start a debugging session using the `Run Extension Tests` launch configuration.

**NOTE:** See the [`Development > Debugging`](#debugging) section above for instructions for starting a debugging session using a launch configuration.
**NOTE:** See the [`Development > Debugging`](#debugging) section above for instructions for starting
a debugging session using a launch configuration.

**NOTE:** For instructions for manual feature testing, refer to the ["Manual Feature Testing Guide"](/TESTING.md).

Expand All @@ -86,9 +96,8 @@ Licensed under [GPL-3.0](/LICENSE).

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the GPL-3.0 license, shall be
licensed as above, without any additional terms or conditions.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you,
as defined in the GPL-3.0 license, shall be licensed as above, without any additional terms or conditions.

## Acknowledgements

Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,10 @@

This extension provides the following settings:

- `ink-analyzer.server.path`: **(Optional)** Sets the path to ink! Language Server (ink-lsp-server) binary/executable (points to the bundled binary/executable that ships with the extension by default).
- `ink-analyzer.trace.server`: **(Optional)** Enables/disables tracing of the communication between VS Code and the ink! Language Server (not recommended for regular users).
- `ink-analyzer.server.path`: **(Optional)** Sets the path to ink! Language Server (ink-lsp-server) binary/executable
(points to the bundled binary/executable that ships with the extension by default).
- `ink-analyzer.trace.server`: **(Optional)** Enables/disables tracing of the communication between VS Code and
the ink! Language Server (not recommended for regular users).

## Development and Testing

Expand All @@ -109,9 +111,8 @@ Licensed under [GPL-3.0](/LICENSE).

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the GPL-3.0 license, shall be
licensed as above, without any additional terms or conditions.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you,
as defined in the GPL-3.0 license, shall be licensed as above, without any additional terms or conditions.

## Acknowledgements

Expand Down
Loading

0 comments on commit f9e21fe

Please sign in to comment.