Skip to content

Commit 843779a

Browse files
Jolg42Jolg42
authored
chore: VSCode -> VS Code (#1467)
1 parent c6e75b7 commit 843779a

19 files changed

+47
-44
lines changed

‎.github/workflows/1_2_b_bump_extension_only.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ jobs:
4646
- name: Checkout previous branch
4747
if: endsWith(github.ref, '/main') == false
4848
run: git checkout ${{ github.ref_name }}
49-
- name: Update VSCode extension version
49+
- name: Update VS Code extension version
5050
run: |
5151
node scripts/update_package_json_files.js dev ${{ steps.update.outputs.next_extension_version }} ""
5252
- name: Install Dependencies

‎.github/workflows/1_2_c_promote_patch_to_stable.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
id: setup_branch
4040
run: |
4141
sh scripts/setup_branch.sh "promote_patch-dev"
42-
- name: Update VSCode extension version
42+
- name: Update VS Code extension version
4343
run: |
4444
node scripts/update_package_json_files.js latest ${{ steps.update.outputs.next_extension_version }} ""
4545
- name: Install Dependencies

‎.github/workflows/2_bump_versions.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ jobs:
5959
run: |
6060
git reset --hard main
6161
git push --force origin stable
62-
- name: Update Prisma CLI version and VSCode extension version
62+
- name: Update Prisma CLI version and VS Code extension version
6363
run: |
6464
node scripts/update_package_json_files.js ${{ github.event.inputs.npm_channel }} ${{ steps.update.outputs.next_extension_version }} ${{ github.event.inputs.version }}
6565
- name: Install Dependencies to update lock file

‎.github/workflows/3_LS_tests_publish.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
description: 'Prisma CLI NPM Channel'
99
required: true
1010
extension_version:
11-
description: 'VSCode extension version'
11+
description: 'VS Code extension version'
1212
required: true
1313
branch:
1414
description: 'Branch to run run this workflow on'

‎.github/workflows/4_bump_LS_in_extension.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: 4. Bump LS in VSCode extension
2-
run-name: 4. Bump LS in VSCode extension - ${{ inputs.trigger_reason }}
2+
run-name: 4. Bump LS in VS Code extension - ${{ inputs.trigger_reason }}
33

44
on:
55
workflow_dispatch:
@@ -8,7 +8,7 @@ on:
88
description: 'Prisma CLI NPM Channel'
99
required: true
1010
extension_version:
11-
description: 'VSCode extension version'
11+
description: 'VS Code extension version'
1212
required: true
1313
branch:
1414
description: 'Branch to run run this workflow on'
@@ -23,7 +23,7 @@ env:
2323

2424
jobs:
2525
bump:
26-
name: Bump LS in VSCode extension
26+
name: Bump LS in VS Code extension
2727
runs-on: ubuntu-latest
2828
timeout-minutes: 7
2929
steps:
@@ -61,9 +61,9 @@ jobs:
6161
6262
- name: Commit and push to branch
6363
run: |
64-
sh scripts/commit_and_push.sh "Bump LS to ${{ github.event.inputs.extension_version }} in VSCode. Engines: ${{ steps.packagejson.outputs.engines }}"
64+
sh scripts/commit_and_push.sh "Bump LS to ${{ github.event.inputs.extension_version }} in VS Code. Engines: ${{ steps.packagejson.outputs.engines }}"
6565
66-
- name: Trigger next workflow for VSCode e2e tests
66+
- name: Trigger next workflow for VS Code e2e tests
6767
uses: benc-uk/workflow-dispatch@v1
6868
with:
6969
workflow: 5. Integration tests in VSCode folder with published LS

‎.github/workflows/5_e2e_tests.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: 5. Integration tests in VSCode folder with published LS
2-
run-name: 5. Integration tests in VSCode folder with published LS - ${{ inputs.trigger_reason }}
2+
run-name: 5. Integration tests in VS Code folder with published LS - ${{ inputs.trigger_reason }}
33

44
on:
55
workflow_dispatch:
@@ -8,7 +8,7 @@ on:
88
description: 'Prisma CLI NPM Channel'
99
required: true
1010
extension_version:
11-
description: 'VSCode extension version'
11+
description: 'VS Code extension version'
1212
required: true
1313
branch:
1414
description: 'Branch to run run this workflow on'
@@ -22,7 +22,7 @@ env:
2222

2323
jobs:
2424
tests:
25-
name: Integration tests in VSCode folder with published LS
25+
name: Integration tests in VS Code folder with published LS
2626
runs-on: ${{ matrix.os }}
2727
timeout-minutes: 10
2828
strategy:

‎.github/workflows/6_build.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
description: 'Prisma CLI NPM Channel'
99
required: true
1010
extension_version:
11-
description: 'VSCode extension version'
11+
description: 'VS Code extension version'
1212
required: true
1313
branch:
1414
description: 'Branch to run run this workflow on'

‎.github/workflows/7_publish.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ jobs:
4343
- name: Install Dependencies
4444
run: npm install && npm run bootstrap
4545

46-
# Download Asset from GH release and publish to VSCode marketplace
46+
# Download Asset from GH release and publish to VS Code marketplace
4747
- uses: dsaltares/fetch-gh-release-asset@master
4848
with:
4949
repo: 'prisma/language-tools'

‎.github/workflows/e2e_published_vsix.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
description: 'Insider or stable extension'
99
required: true
1010
extension_version:
11-
description: 'VSCode extension version'
11+
description: 'VS Code extension version'
1212
required: true
1313

1414
env:

‎.vscode/launch.json

+13-6
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"version": "0.2.0",
77
"configurations": [
88
{
9-
"name": "Launch VSCode extension",
9+
"name": "Launch VS Code extension",
1010
"type": "extensionHost",
1111
"request": "launch",
1212
"runtimeExecutable": "${execPath}",
@@ -15,7 +15,9 @@
1515
"--extensionDevelopmentPath=${workspaceFolder}/packages/vscode",
1616
"--disable-extensions"
1717
],
18-
"outFiles": ["${workspaceFolder}/packages/vscode/dist/**/*.js"],
18+
"outFiles": [
19+
"${workspaceFolder}/packages/vscode/dist/**/*.js"
20+
],
1921
"env": {
2022
"VSCODE_DEBUG_MODE": "true"
2123
}
@@ -27,7 +29,9 @@
2729
"port": 6009,
2830
"restart": true,
2931
"timeout": 50000,
30-
"outFiles": ["${workspaceFolder}/packages/language-server/dist/**/*.js"]
32+
"outFiles": [
33+
"${workspaceFolder}/packages/language-server/dist/**/*.js"
34+
]
3135
},
3236
{
3337
"name": "Run Language Server Tests",
@@ -71,8 +75,11 @@
7175
],
7276
"compounds": [
7377
{
74-
"name": "VSCode + Language Server",
75-
"configurations": ["Launch VSCode extension", "Attach to Server"]
78+
"name": "VS Code + Language Server",
79+
"configurations": [
80+
"Launch VS Code extension",
81+
"Attach to Server"
82+
]
7683
}
7784
]
78-
}
85+
}

‎nix/vscode.nix

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@
2626
npm prune --production
2727
popd
2828
29-
echo 'Building VSCode extension...'
29+
echo 'Building VS Code extension...'
3030
pushd ./packages/vscode
3131
npm install
3232
npm run build
3333
popd
3434
3535
echo 'ok'
3636
'';
37-
# Start a VSCode instance with completely default configuration.
37+
# Start a VS Code instance with completely default configuration.
3838
# Follow the instructions from CONTRIBUTING.md to manually start
39-
# another instance of VSCode with the local build of the extension
39+
# another instance of VS Code with the local build of the extension
4040
# (unpackaged) locally.
4141
code = pkgs.writeShellScriptBin "code" ''
4242
TMPDIR=`mktemp -d`

‎packages/language-server/CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
- Run `npm run watch`.
77
- Open VS Code on this folder.
88
- Switch to the debug viewlet.
9-
- Select `Launch VSCode extension` from the drop down.
9+
- Select `Launch VS Code extension` from the drop down.
1010
- Run the launch config.
1111
- To debug the server as well use the launch configuration `Attach to Server` afterwards.
12-
- A new file should open in the [Extension Development Host] instance of VSCode.
12+
- A new file should open in the [Extension Development Host] instance of VS Code.
1313
- Change the language to Prisma.
1414
- Make a change to the syntax
15-
- To reload, press the reload button in VSCode ( **Developer: Inspect TM Scopes** is helpful for debugging syntax issues )
15+
- To reload, press the reload button in VS Code ( **Developer: Inspect TM Scopes** is helpful for debugging syntax issues )
1616

1717
## Testing
1818

‎packages/language-server/src/server.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ export function startServer(options?: LSOptions): void {
100100
})
101101

102102
// The global settings, used when the `workspace/configuration` request is not supported by the client or is not set by the user.
103-
// This does not apply to VSCode, as this client supports this setting.
103+
// This does not apply to VS Code, as this client supports this setting.
104104
// const defaultSettings: LSSettings = {}
105105
// let globalSettings: LSSettings = defaultSettings // eslint-disable-line
106106

‎packages/vscode/CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The `main` branch of this repository contains the VS Code extension for Prisma schema files. Prisma package dependencies are kept up to date with [a GitHub Action workflow](/.github/workflows/1_check_for_updates.yml), that updates them every time a new version of them is released.
66

7-
There is a stable version `prisma` and an unstable version `prisma-insider`. The stable one is published as ["Prisma" in the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma), the unstable one as ["Prisma - Insider"](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma-insider). An automated publish runs every 5 minutes calling the `check-update.sh` script.
7+
There is a stable version `prisma` and an unstable version `prisma-insider`. The stable one is published as ["Prisma" in the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma), the unstable one as ["Prisma - Insider"](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma-insider). An automated publish runs every 5 minutes calling the `check-update.sh` script.
88
In the beginning of this run, the CI job checks for Prisma stable version and `scripts/prisma_version_stable` contents to be the same. If the Prisma stable version is a new minor release, it makes the required version changes and proceeds further in the job. `scripts/prisma_version_stable` is a file that is committed by the stable CI job. That enables the future runs to know if an extension version is already published for a specific Prisma CLI version.
99

1010
If there is a new Prisma Patch, a new patch branch from the last stable release tag is created if it does not exist yet. It then makes the required version changes and releases a new Insider extension. This script also triggers the release of a new Stable extension, incrementing the version number each time.
@@ -38,21 +38,21 @@ On push to the `main` branch, a new Insider extension is released, with an incre
3838
- Run `npm run watch`.
3939
- Open VS Code on this folder.
4040
- Switch to the debug viewlet.
41-
- Select `Launch VSCode extension` from the drop down.
41+
- Select `Launch VS Code extension` from the drop down.
4242
- Run the launch config. (This will always use the local Language Server, not the published one.)
4343
- If you want to debug the server as well use the launch configuration `Attach to Server` afterwards.
44-
- A new file should open in the [Extension Development Host] instance of VSCode.
44+
- A new file should open in the [Extension Development Host] instance of VS Code.
4545
- Change the language to Prisma.
4646
- Make a change to the syntax
47-
- To reload, press the reload button in VSCode (**Developer: Inspect TM Scopes** is helpful for debugging syntax issues)
47+
- To reload, press the reload button in VS Code (**Developer: Inspect TM Scopes** is helpful for debugging syntax issues)
4848

4949
### Dependencies
5050

5151
- the version of `@types/vscode` must always be smaller or equal to the `engines.vscode` version. Otherwise the extension can not be packaged.
5252

5353
## Debugging
5454

55-
- Set `prisma.trace.server` to `messages` or `verbose` to trace the communication between VSCode and the language server.
55+
- Set `prisma.trace.server` to `messages` or `verbose` to trace the communication between VS Code and the language server.
5656
- There is a tool to visualize and filter the communication between Language Client / Server. All logs from the channel can be saved into a file, and loaded with the Language Server Protocol Inspector at https://microsoft.github.io/language-server-protocol/inspector
5757

5858
## Testing

‎packages/vscode/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -158,4 +158,4 @@
158158
"access": "public"
159159
},
160160
"preview": true
161-
}
161+
}

‎packages/vscode/src/plugins/prisma-language-server/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ const plugin: PrismaVSCodePlugin = {
135135
console.log(`serverModule: ${serverModule}`)
136136

137137
// The debug options for the server
138-
// --inspect=6009: runs the server in Node's Inspector mode so VSCode can attach to the server for debugging
138+
// --inspect=6009: runs the server in Node's Inspector mode so VS Code can attach to the server for debugging
139139
const debugOptions = {
140140
execArgv: ['--nolazy', '--inspect=6009'],
141141
env: { DEBUG: true },

‎packages/vscode/src/util.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ function showToastToSwitchColorTheme(currentTheme: string, suggestedTheme: strin
3636
// We do not want to block on this UI message, therefore disabling the linter here.
3737
// eslint-disable-next-line @typescript-eslint/no-floating-promises
3838
window.showWarningMessage(
39-
`The VSCode Color Theme '${currentTheme}' you are using unfortunately does not fully support syntax highlighting. We suggest you switch to '${suggestedTheme}' which does fully support it and will give you a better experience.`,
39+
`The VS Code Color Theme '${currentTheme}' you are using unfortunately does not fully support syntax highlighting. We suggest you switch to '${suggestedTheme}' which does fully support it and will give you a better experience.`,
4040
)
4141
}
4242

‎renovate.json

+2-6
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"rebaseWhen": "conflicted",
88
"packageRules": [
99
{
10-
"groupName": "VSCode",
10+
"groupName": "VS Code",
1111
"packageNames": ["vscode", "@types/vscode"],
1212
"updateTypes": ["patch", "minor"]
1313
},
@@ -38,11 +38,7 @@
3838
{
3939
"groupName": "dependencies (non-major)",
4040
"depTypeList": ["dependencies"],
41-
"excludePackageNames": [
42-
"@prisma/language-server",
43-
"@types/vscode",
44-
"@prisma/prisma-schema-wasm"
45-
],
41+
"excludePackageNames": ["@prisma/language-server", "@types/vscode", "@prisma/prisma-schema-wasm"],
4642
"updateTypes": ["patch", "minor"]
4743
}
4844
]

‎scripts/e2eTestsOnVsix/install_extension.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ async function installExtension({ extensionType, extensionVersion }) {
1010
}
1111
const extensionName = `Prisma.prisma${vsceArgument}`
1212

13-
// Install VSCode
13+
// Install VS Code
1414
const vscodeExecutablePath = await vscodeTest.downloadAndUnzipVSCode('stable')
1515

1616
console.debug({ vscodeExecutablePath })
1717

18-
// Install VSCode extension
18+
// Install VS Code extension
1919
const [cli, ...args] = vscodeTest.resolveCliArgsFromVSCodeExecutablePath(vscodeExecutablePath)
2020

2121
console.debug({ cli })

0 commit comments

Comments
 (0)