Skip to content

Commit 6c4fed7

Browse files
committed
Prettify
1 parent 09d5cab commit 6c4fed7

File tree

98 files changed

+4470
-4089
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+4470
-4089
lines changed

.eslintrc.js

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ module.exports = {
1515
'@typescript-eslint/naming-convention': [
1616
'error',
1717
{
18-
'selector': 'interface',
19-
'format': ['PascalCase'],
20-
'custom': {
21-
'regex': '^I[A-Z]',
22-
'match': true
18+
selector: 'interface',
19+
format: ['PascalCase'],
20+
custom: {
21+
regex: '^I[A-Z]',
22+
match: true
2323
}
2424
}
2525
],
@@ -36,12 +36,12 @@ module.exports = {
3636
eqeqeq: 'error',
3737
'prefer-arrow-callback': 'error'
3838
},
39-
overrides: [
40-
{
41-
files: ['*.ts'],
42-
parserOptions: {
43-
project: ['./tsconfig.eslint.json'],
44-
},
45-
},
46-
],
39+
overrides: [
40+
{
41+
files: ['*.ts'],
42+
parserOptions: {
43+
project: ['./tsconfig.eslint.json']
44+
}
45+
}
46+
]
4747
};

CONTRIBUTING.md

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Contributing to JupyterLab
2-
==========================
1+
# Contributing to JupyterLab
32

43
If you're reading this section, you're probably interested in
54
contributing to JupyterLab. Welcome and thanks for your interest in
@@ -8,52 +7,43 @@ contributing!
87
Please take a look at the Contributor documentation, familiarize
98
yourself with using JupyterLab, and introduce yourself to the community
109
(on the mailing list or discourse) and share what area of the project
11-
you are interested in working on. Please also see the Jupyter `Community
12-
Guides <https://jupyter.readthedocs.io/en/latest/community/content-community.html>`__.
10+
you are interested in working on. Please also see the Jupyter `Community Guides <https://jupyter.readthedocs.io/en/latest/community/content-community.html>`\_\_.
1311

14-
We have labeled some issues as `good first
15-
issue <https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`__
16-
or `help
17-
wanted <https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22>`__
12+
We have labeled some issues as `good first issue <https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`**
13+
or `help wanted <https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22>`**
1814
that we believe are good examples of small, self-contained changes. We
1915
encourage those that are new to the code base to implement and/or ask
2016
questions about these issues.
2117

2218
If you believe you’ve found a security vulnerability in JupyterLab or
2319
any Jupyter project, please report it to security@ipython.org. If you
24-
prefer to encrypt your security reports, you can use `this PGP public
25-
key <https://raw.githubusercontent.com/jupyter/notebook/master/docs/source/ipython_security.asc>`__.
20+
prefer to encrypt your security reports, you can use `this PGP public key <https://raw.githubusercontent.com/jupyter/notebook/master/docs/source/ipython_security.asc>`\_\_.
2621

2722
.. contents:: Table of contents
28-
:local:
29-
:depth: 1
23+
:local:
24+
:depth: 1
3025

31-
General Guidelines for Contributing
32-
-----------------------------------
26+
## General Guidelines for Contributing
3327

3428
For general documentation about contributing to Jupyter projects, see
35-
the `Project Jupyter Contributor
36-
Documentation <https://jupyter.readthedocs.io/en/latest/contributing/content-contributor.html>`__
37-
and `Code of
38-
Conduct <https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md>`__.
29+
the `Project Jupyter Contributor Documentation <https://jupyter.readthedocs.io/en/latest/contributing/content-contributor.html>`**
30+
and `Code of Conduct <https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md>`**.
3931

4032
All source code is written in
41-
`TypeScript <https://www.typescriptlang.org/Handbook>`__. See the `Style
42-
Guide <https://github.com/jupyterlab/jupyterlab/wiki/TypeScript-Style-Guide>`__.
33+
`TypeScript <https://www.typescriptlang.org/Handbook>`**. See the `Style Guide <https://github.com/jupyterlab/jupyterlab/wiki/TypeScript-Style-Guide>`**.
4334

44-
All source code is formatted using `prettier <https://prettier.io>`__.
35+
All source code is formatted using `prettier <https://prettier.io>`\_\_.
4536
The benefit of using a code formatter like prettier is that it removes the topic of
4637
code style from the conversation when reviewing pull requests, thereby
4738
speeding up the review process.
4839

49-
You may use the prettier npm script (e.g. ``npm run prettier`` or
50-
``yarn prettier``) to format the entire code base.
40+
You may use the prettier npm script (e.g. `npm run prettier` or
41+
`yarn prettier`) to format the entire code base.
5142
We recommend installing a prettier extension for your code editor and
5243
configuring it to format your code with a keyboard shortcut or
5344
automatically on save.
5445

55-
Submitting a Pull Request Contribution
56-
--------------------------------------
46+
## Submitting a Pull Request Contribution
5747

5848
Generally, an issue should be opened describing a piece of proposed work
5949
and the issues it solves before a pull request is opened.

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**WIP this is very early work in progress and nothing is yet working.** But don't hesitate to open issues and PRs if you want to help.
44

5-
![Extension status](https://img.shields.io/badge/status-draft-critical "Not yet working")
5+
![Extension status](https://img.shields.io/badge/status-draft-critical 'Not yet working')
66
[![NPM Version](https://img.shields.io/npm/v/@jupyter-notebook/ui-components?color=blue)](https://www.npmjs.com/package/@jupyter-notebook/ui-components)
77
![Toolkit CI Status](https://github.com/jupyterlab-contrib/jupyter-ui-toolkit/actions/workflows/ci.yml/badge.svg)
88
![Deploy Docs Status](https://github.com/jupyterlab-contrib/jupyter-ui-toolkit/actions/workflows/docs-cd.yml/badge.svg)
@@ -16,10 +16,10 @@ The UI Toolkit is a component library for building web interfaces in Jupyter eco
1616

1717
Features of the library include:
1818

19-
- **Implements the Jupyter design language:** All components follow the design language of Jupyter – enabling developers to create extensions that have a consistent look and feel with the rest of the ecosystem.
20-
- **Automatic support for color themes:** All components are designed with theming in mind and will automatically display the current application theme.
21-
- **Use any tech stack:** The library ships as a set of web components, meaning developers can use the toolkit no matter what tech stack (React, Vue, Svelte, etc.) their extension is built with.
22-
- **Accessible out of the box:** All components ship with web standard compliant ARIA labels and keyboard navigation.
19+
- **Implements the Jupyter design language:** All components follow the design language of Jupyter – enabling developers to create extensions that have a consistent look and feel with the rest of the ecosystem.
20+
- **Automatic support for color themes:** All components are designed with theming in mind and will automatically display the current application theme.
21+
- **Use any tech stack:** The library ships as a set of web components, meaning developers can use the toolkit no matter what tech stack (React, Vue, Svelte, etc.) their extension is built with.
22+
- **Accessible out of the box:** All components ship with web standard compliant ARIA labels and keyboard navigation.
2323

2424
Note this project started as a fork of the [WebView toolkit for Visual Studio Code](https://github.com/microsoft/vscode-webview-ui-toolkit) (licensed under MIT) on which Jupyter design specification. The fundamental technology used is [Fast Design](https://www.fast.design/).
2525

@@ -44,9 +44,9 @@ npm install --save @vscode/webview-ui-toolkit
4444

4545
Further documentation can be found in the following places:
4646

47-
- [Component Docs](./packages/components/docs/components.md)
48-
- [Storybook (Interactive Component Sandbox)](https://microsoft.github.io/vscode-webview-ui-toolkit/)
49-
- [Toolkit Extension Samples](./packages/lab-example)
47+
- [Component Docs](./packages/components/docs/components.md)
48+
- [Storybook (Interactive Component Sandbox)](https://microsoft.github.io/vscode-webview-ui-toolkit/)
49+
- [Toolkit Extension Samples](./packages/lab-example)
5050

5151
## Contributing
5252

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import {create} from '@storybook/theming/create';
1+
import { create } from '@storybook/theming/create';
22

33
export default create({
4-
base: 'light',
5-
brandTitle: 'Jupyter UI Toolkit',
6-
brandUrl: 'https://github.com/jupyterlab-contrib/jupyter-ui-toolkit',
4+
base: 'light',
5+
brandTitle: 'Jupyter UI Toolkit',
6+
brandUrl: 'https://github.com/jupyterlab-contrib/jupyter-ui-toolkit'
77
});
Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
module.exports = {
2-
core: {
3-
builder: 'webpack5',
4-
},
5-
stories: [
6-
'../src/**/*.stories.mdx',
7-
'../src/**/*.stories.@(js|jsx|ts|tsx)',
8-
'../docs/**/*.stories.mdx',
9-
],
10-
addons: [
11-
'@storybook/addon-links',
12-
'@storybook/addon-essentials',
13-
'@storybook/addon-a11y',
14-
],
15-
features: {
16-
postcss: false,
17-
},
2+
core: {
3+
builder: 'webpack5'
4+
},
5+
stories: [
6+
'../src/**/*.stories.mdx',
7+
'../src/**/*.stories.@(js|jsx|ts|tsx)',
8+
'../docs/**/*.stories.mdx'
9+
],
10+
addons: [
11+
'@storybook/addon-links',
12+
'@storybook/addon-essentials',
13+
'@storybook/addon-a11y'
14+
],
15+
features: {
16+
postcss: false
17+
}
1818
};
Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
import {addons} from '@storybook/addons';
1+
import { addons } from '@storybook/addons';
22
import customTheme from './customTheme';
33

44
addons.setConfig({
5-
isFullscreen: false,
6-
showNav: true,
7-
showPanel: true,
8-
panelPosition: 'bottom',
9-
sidebarAnimations: true,
10-
enableShortcuts: false,
11-
isToolshown: true,
12-
theme: customTheme,
13-
selectedPanel: undefined,
14-
initialActive: 'sidebar',
15-
showRoots: true,
5+
isFullscreen: false,
6+
showNav: true,
7+
showPanel: true,
8+
panelPosition: 'bottom',
9+
sidebarAnimations: true,
10+
enableShortcuts: false,
11+
isToolshown: true,
12+
theme: customTheme,
13+
selectedPanel: undefined,
14+
initialActive: 'sidebar',
15+
showRoots: true
1616
});
Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
11
import * as JupyterComponents from '../src/index-rollup';
2-
import {themes} from '@storybook/theming';
2+
import { themes } from '@storybook/theming';
33

44
JupyterComponents;
55

66
export const parameters = {
7-
actions: {argTypesRegex: '^on[A-Z].*'},
8-
options: {
9-
storySort: {
10-
order: ['Docs', 'Library'],
11-
},
12-
isToolshown: true,
13-
enableShortcuts: false,
14-
},
15-
docs: {
16-
theme: themes.light,
17-
},
18-
backgrounds: {
19-
default: 'dark',
20-
values: [
21-
{
22-
name: 'light',
23-
value: '#f9f9f9',
24-
},
25-
{
26-
name: 'grey',
27-
value: '#929396',
28-
},
29-
{
30-
name: 'dark',
31-
value: '#252526',
32-
},
33-
],
34-
},
7+
actions: { argTypesRegex: '^on[A-Z].*' },
8+
options: {
9+
storySort: {
10+
order: ['Docs', 'Library']
11+
},
12+
isToolshown: true,
13+
enableShortcuts: false
14+
},
15+
docs: {
16+
theme: themes.light
17+
},
18+
backgrounds: {
19+
default: 'dark',
20+
values: [
21+
{
22+
name: 'light',
23+
value: '#f9f9f9'
24+
},
25+
{
26+
name: 'grey',
27+
value: '#929396'
28+
},
29+
{
30+
name: 'dark',
31+
value: '#252526'
32+
}
33+
]
34+
}
3535
};
Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
{
2-
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"mainEntryPointFilePath": "dist/dts/index.d.ts",
4-
"apiReport": {
5-
"enabled": true,
6-
"reportFolder": "docs",
7-
"reportFileName": "api-report.md"
8-
},
9-
"docModel": {
10-
"enabled": false
11-
},
12-
"dtsRollup": {
13-
"enabled": true,
14-
"untrimmedFilePath": "dist/toolkit.d.ts"
15-
}
2+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3+
"mainEntryPointFilePath": "dist/dts/index.d.ts",
4+
"apiReport": {
5+
"enabled": true,
6+
"reportFolder": "docs",
7+
"reportFileName": "api-report.md"
8+
},
9+
"docModel": {
10+
"enabled": false
11+
},
12+
"dtsRollup": {
13+
"enabled": true,
14+
"untrimmedFilePath": "dist/toolkit.d.ts"
15+
}
1616
}

0 commit comments

Comments
 (0)