Skip to content

Commit a1dbf46

Browse files
dlqqqdlqqq
authored
Rename NPM package (#166)
* rename @jupyter/server-documents => @jupyter-ai-contrib/server-documents * rename disableSave plugin to align w/ convention
1 parent 15bf7ff commit a1dbf46

File tree

15 files changed

+206
-202
lines changed

15 files changed

+206
-202
lines changed

‎.github/workflows/build.yml‎

Lines changed: 118 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -15,83 +15,83 @@ jobs:
1515
runs-on: ubuntu-latest
1616

1717
steps:
18-
- name: Checkout
19-
uses: actions/checkout@v4
20-
21-
- name: Base Setup
22-
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
23-
24-
- name: Install dependencies
25-
run: python -m pip install -U "jupyterlab>=4.0.0,<5"
26-
27-
- name: Lint the extension
28-
run: |
29-
set -eux
30-
jlpm
31-
jlpm run lint:check
32-
33-
- name: Test the extension
34-
run: |
35-
set -eux
36-
jlpm run test
37-
38-
- name: Build the extension
39-
run: |
40-
set -eux
41-
python -m pip install .[test]
42-
43-
pytest -vv -r ap --cov jupyter_server_documents
44-
jupyter server extension list
45-
jupyter server extension list 2>&1 | grep -ie "jupyter_server_documents.*OK"
46-
47-
jupyter labextension list
48-
jupyter labextension list 2>&1 | grep -ie "@jupyter/server-documents.*OK"
49-
python -m jupyterlab.browser_check
50-
51-
- name: Package the extension
52-
run: |
53-
set -eux
54-
55-
pip install build
56-
python -m build
57-
pip uninstall -y "jupyter_server_documents" jupyterlab
58-
59-
- name: Upload extension packages
60-
uses: actions/upload-artifact@v4
61-
with:
62-
name: extension-artifacts
63-
path: dist/jupyter_server_documents*
64-
if-no-files-found: error
18+
- name: Checkout
19+
uses: actions/checkout@v4
20+
21+
- name: Base Setup
22+
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
23+
24+
- name: Install dependencies
25+
run: python -m pip install -U "jupyterlab>=4.0.0,<5"
26+
27+
- name: Lint the extension
28+
run: |
29+
set -eux
30+
jlpm
31+
jlpm run lint:check
32+
33+
- name: Test the extension
34+
run: |
35+
set -eux
36+
jlpm run test
37+
38+
- name: Build the extension
39+
run: |
40+
set -eux
41+
python -m pip install .[test]
42+
43+
pytest -vv -r ap --cov jupyter_server_documents
44+
jupyter server extension list
45+
jupyter server extension list 2>&1 | grep -ie "jupyter_server_documents.*OK"
46+
47+
jupyter labextension list
48+
jupyter labextension list 2>&1 | grep -ie "@jupyter-ai-contrib/server-documents.*OK"
49+
python -m jupyterlab.browser_check
50+
51+
- name: Package the extension
52+
run: |
53+
set -eux
54+
55+
pip install build
56+
python -m build
57+
pip uninstall -y "jupyter_server_documents" jupyterlab
58+
59+
- name: Upload extension packages
60+
uses: actions/upload-artifact@v4
61+
with:
62+
name: extension-artifacts
63+
path: dist/jupyter_server_documents*
64+
if-no-files-found: error
6565

6666
test_isolated:
6767
needs: build
6868
runs-on: ubuntu-latest
6969

7070
steps:
71-
- name: Install Python
72-
uses: actions/setup-python@v5
73-
with:
74-
python-version: '3.10'
75-
architecture: 'x64'
76-
- uses: actions/download-artifact@v4
77-
with:
78-
name: extension-artifacts
79-
- name: Install and Test
80-
run: |
81-
set -eux
82-
# Remove NodeJS, twice to take care of system and locally installed node versions.
83-
sudo rm -rf $(which node)
84-
sudo rm -rf $(which node)
85-
86-
pip install "jupyterlab>=4.0.0,<5" jupyter_server_documents*.whl
87-
88-
89-
jupyter server extension list
90-
jupyter server extension list 2>&1 | grep -ie "jupyter_server_documents.*OK"
91-
92-
jupyter labextension list
93-
jupyter labextension list 2>&1 | grep -ie "@jupyter/server-documents.*OK"
94-
python -m jupyterlab.browser_check --no-browser-test
71+
- name: Install Python
72+
uses: actions/setup-python@v5
73+
with:
74+
python-version: '3.10'
75+
architecture: 'x64'
76+
- uses: actions/download-artifact@v4
77+
with:
78+
name: extension-artifacts
79+
- name: Install and Test
80+
run: |
81+
set -eux
82+
# Remove NodeJS, twice to take care of system and locally installed node versions.
83+
sudo rm -rf $(which node)
84+
sudo rm -rf $(which node)
85+
86+
pip install "jupyterlab>=4.0.0,<5" jupyter_server_documents*.whl
87+
88+
89+
jupyter server extension list
90+
jupyter server extension list 2>&1 | grep -ie "jupyter_server_documents.*OK"
91+
92+
jupyter labextension list
93+
jupyter labextension list 2>&1 | grep -ie "@jupyter-ai-contrib/server-documents.*OK"
94+
python -m jupyterlab.browser_check --no-browser-test
9595
9696
integration-tests:
9797
name: Integration tests
@@ -102,53 +102,53 @@ jobs:
102102
PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/pw-browsers
103103

104104
steps:
105-
- name: Checkout
106-
uses: actions/checkout@v4
107-
108-
- name: Base Setup
109-
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
110-
111-
- name: Download extension package
112-
uses: actions/download-artifact@v4
113-
with:
114-
name: extension-artifacts
115-
116-
- name: Install the extension
117-
run: |
118-
set -eux
119-
python -m pip install "jupyterlab>=4.0.0,<5" jupyter_server_documents*.whl
120-
121-
- name: Install dependencies
122-
working-directory: ui-tests
123-
env:
124-
YARN_ENABLE_IMMUTABLE_INSTALLS: 0
125-
PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
126-
run: jlpm install
127-
128-
- name: Set up browser cache
129-
uses: actions/cache@v4
130-
with:
131-
path: |
132-
${{ github.workspace }}/pw-browsers
133-
key: ${{ runner.os }}-${{ hashFiles('ui-tests/yarn.lock') }}
134-
135-
- name: Install browser
136-
run: jlpm playwright install chromium
137-
working-directory: ui-tests
138-
139-
- name: Execute integration tests
140-
working-directory: ui-tests
141-
run: |
142-
jlpm playwright test
143-
144-
- name: Upload Playwright Test report
145-
if: always()
146-
uses: actions/upload-artifact@v4
147-
with:
148-
name: jupyter_server_documents-playwright-tests
149-
path: |
150-
ui-tests/test-results
151-
ui-tests/playwright-report
105+
- name: Checkout
106+
uses: actions/checkout@v4
107+
108+
- name: Base Setup
109+
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
110+
111+
- name: Download extension package
112+
uses: actions/download-artifact@v4
113+
with:
114+
name: extension-artifacts
115+
116+
- name: Install the extension
117+
run: |
118+
set -eux
119+
python -m pip install "jupyterlab>=4.0.0,<5" jupyter_server_documents*.whl
120+
121+
- name: Install dependencies
122+
working-directory: ui-tests
123+
env:
124+
YARN_ENABLE_IMMUTABLE_INSTALLS: 0
125+
PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
126+
run: jlpm install
127+
128+
- name: Set up browser cache
129+
uses: actions/cache@v4
130+
with:
131+
path: |
132+
${{ github.workspace }}/pw-browsers
133+
key: ${{ runner.os }}-${{ hashFiles('ui-tests/yarn.lock') }}
134+
135+
- name: Install browser
136+
run: jlpm playwright install chromium
137+
working-directory: ui-tests
138+
139+
- name: Execute integration tests
140+
working-directory: ui-tests
141+
run: |
142+
jlpm playwright test
143+
144+
- name: Upload Playwright Test report
145+
if: always()
146+
uses: actions/upload-artifact@v4
147+
with:
148+
name: jupyter_server_documents-playwright-tests
149+
path: |
150+
ui-tests/test-results
151+
ui-tests/playwright-report
152152
153153
check_links:
154154
name: Check Links

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Jupyter Server Documents
22

33
This extension is composed of a Python package named `jupyter_server_documents`
4-
for the server extension and a NPM package named `@jupyter/server-documents`
4+
for the server extension and a NPM package named `@jupyter-ai-contrib/server-documents`
55
for the frontend extension.
66

77
## Overview
@@ -179,7 +179,7 @@ jlpm dev:uninstall
179179
In development mode, you will also need to remove the symlink created by
180180
`jupyter labextension develop` command. To find its location, you can run
181181
`jupyter labextension list` to figure out where the `labextensions` folder is
182-
located. Then you can remove the symlink named `@jupyter/server-documents` within that
182+
located. Then you can remove the symlink named `@jupyter-ai-contrib/server-documents` within that
183183
folder.
184184

185185
### Testing the extension

‎jupyter_server_documents/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
def _jupyter_labextension_paths():
1717
return [{
1818
"src": "labextension",
19-
"dest": "@jupyter/server-documents"
19+
"dest": "@jupyter-ai-contrib/server-documents"
2020
}]
2121

2222

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@jupyter/server-documents",
2+
"name": "@jupyter-ai-contrib/server-documents",
33
"version": "0.1.0-a6",
44
"description": "A JupyterLab extension that provides RTC capabilities.",
55
"keywords": [

‎pyproject.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ artifacts = ["jupyter_server_documents/labextension"]
5757
exclude = [".github", "binder"]
5858

5959
[tool.hatch.build.targets.wheel.shared-data]
60-
"jupyter_server_documents/labextension" = "share/jupyter/labextensions/@jupyter/server-documents"
61-
"install.json" = "share/jupyter/labextensions/@jupyter/server-documents/install.json"
60+
"jupyter_server_documents/labextension" = "share/jupyter/labextensions/@jupyter-ai-contrib/server-documents"
61+
"install.json" = "share/jupyter/labextensions/@jupyter-ai-contrib/server-documents/install.json"
6262
"jupyter-config/server-config" = "etc/jupyter/jupyter_server_config.d"
6363

6464
[tool.hatch.build.hooks.version]

‎schema/plugin.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"jupyter.lab.shortcuts": [],
3-
"title": "@jupyter/server-documents",
4-
"description": "@jupyter/server-documents settings.",
3+
"title": "@jupyter-ai-contrib/server-documents",
4+
"description": "@jupyter-ai-contrib/server-documents settings.",
55
"type": "object",
66
"properties": {},
77
"additionalProperties": false,

‎src/__tests__/jupyter_rtc_core.spec.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Example of [Jest](https://jestjs.io/docs/getting-started) unit tests
33
*/
44

5-
describe('@jupyter/server-documents', () => {
5+
describe('@jupyter-ai-contrib/server-documents', () => {
66
it('should be tested', () => {
77
expect(1 + 1).toEqual(2);
88
});

‎src/codemirror-binding/plugin.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { ybinding } from './ybinding';
1818
* CodeMirror shared model binding provider.
1919
*/
2020
export const codemirrorYjsPlugin: JupyterFrontEndPlugin<void> = {
21-
id: '@jupyter/server-documents:ybinding',
21+
id: '@jupyter-ai-contrib/server-documents:ybinding',
2222
description:
2323
'Register the CodeMirror extension factory binding the editor and the shared model.',
2424
autoStart: true,

‎src/disablesave.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ const NOTIFICATION_INTERVAL = 20;
2323
* Plugin to disable save commands
2424
*/
2525
export const disableSavePlugin: JupyterFrontEndPlugin<void> = {
26-
id: 'disable-save:plugin',
26+
id: '@jupyter-ai-contrib/server-documents:disable-save-plugin',
2727
description:
2828
'Disables save commands and removes their keyboard shortcuts since documents are autosaved',
2929
autoStart: true,

‎src/docprovider/filebrowser.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ const TWO_SESSIONS_WARNING =
4545

4646
export const rtcContentProvider: JupyterFrontEndPlugin<ICollaborativeContentProvider> =
4747
{
48-
id: '@jupyter/server-documents:rtc-content-provider',
48+
id: '@jupyter-ai-contrib/server-documents:rtc-content-provider',
4949
description: 'The RTC content provider',
5050
provides: ICollaborativeContentProvider,
5151
requires: [ITranslator],
@@ -86,7 +86,7 @@ export const rtcContentProvider: JupyterFrontEndPlugin<ICollaborativeContentProv
8686
* Plugin to register the shared model factory for the content type 'file'.
8787
*/
8888
export const yfile: JupyterFrontEndPlugin<void> = {
89-
id: '@jupyter/server-documents:yfile',
89+
id: '@jupyter-ai-contrib/server-documents:yfile',
9090
description:
9191
"Plugin to register the shared model factory for the content type 'file'",
9292
autoStart: true,
@@ -111,7 +111,7 @@ export const yfile: JupyterFrontEndPlugin<void> = {
111111
* Plugin to register the shared model factory for the content type 'notebook'.
112112
*/
113113
export const ynotebook: JupyterFrontEndPlugin<void> = {
114-
id: '@jupyter/server-documents:ynotebook',
114+
id: '@jupyter-ai-contrib/server-documents:ynotebook',
115115
description:
116116
"Plugin to register the shared model factory for the content type 'notebook'",
117117
autoStart: true,
@@ -167,7 +167,7 @@ export const ynotebook: JupyterFrontEndPlugin<void> = {
167167
* was reset. It then clears the content.
168168
*/
169169
export const ychat: JupyterFrontEndPlugin<void> = {
170-
id: '@jupyter/server-documents:ychat',
170+
id: '@jupyter-ai-contrib/server-documents:ychat',
171171
description:
172172
'Plugin to register a custom YChat factory and handle document resets.',
173173
autoStart: true,
@@ -232,7 +232,7 @@ export const ychat: JupyterFrontEndPlugin<void> = {
232232
* The default collaborative drive provider.
233233
*/
234234
export const logger: JupyterFrontEndPlugin<void> = {
235-
id: '@jupyter/server-documents:rtc-drive-logger',
235+
id: '@jupyter-ai-contrib/server-documents:rtc-drive-logger',
236236
description: 'A logging plugin for debugging purposes.',
237237
autoStart: true,
238238
optional: [ILoggerRegistry, IEditorTracker, INotebookTracker, ITranslator],

0 commit comments

Comments
 (0)