Skip to content

Commit

Permalink
Fix some notebook metadata issues (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
bollwyvl committed Oct 23, 2022
1 parent fcf423b commit d9178c2
Show file tree
Hide file tree
Showing 49 changed files with 6,294 additions and 6,769 deletions.
21 changes: 14 additions & 7 deletions .binder/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,31 @@ channels:

dependencies:
# run
- jupyterlab >=3.1.4,<4
- python >=3.7,<3.10
- jupyterlab >=3.4.8,<4
- python >=3.7,<3.11
# build
- brotlipy
- doit
- doit-with-toml
- fonttools
- nodejs >=14,<15
- nodejs >=18,<19
- pip
- twine
- wheel
# qa
- black
- flake8
- isort
# - ssort # only works on py3.8+
# utest
- pytest-cov
- pytest-html
# atest
- firefox =78
- firefox =102
- geckodriver
- robotframework-jupyterlibrary
- robotframework-lint
- robotframework >=6
- robotframework-jupyterlibrary >=0.4.1
- robotframework-robocop >=2.6.0
- robotframework-tidy >=3.3.1
# demo toys
- jupyterlab-link-share
- ipywidgets
147 changes: 88 additions & 59 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,62 +1,91 @@
module.exports = {
env: {
browser: true,
es6: true,
commonjs: true,
node: true,
},
root: true,
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/eslint-recommended',
'plugin:@typescript-eslint/recommended',
'prettier/@typescript-eslint',
env: {
browser: true,
es6: true,
commonjs: true,
node: true,
},
globals: { JSX: 'readonly' },
root: true,
extends: [
'eslint:recommended',
'plugin:import/errors',
'plugin:import/warnings',
'plugin:import/typescript',
'plugin:@typescript-eslint/eslint-recommended',
'plugin:@typescript-eslint/recommended',
'prettier',
'plugin:react/recommended',
],
ignorePatterns: [
'**/node_modules/**/*',
'**/lib/**/*',
'**/_*.ts',
'**/_*.d.ts',
'**/typings/**/*.d.ts',
'**/dist/*',
'js/.eslintrc.js',
],
parser: '@typescript-eslint/parser',
parserOptions: {
project: 'tsconfig.eslint.json',
},
plugins: ['@typescript-eslint', 'import'],
rules: {
'@typescript-eslint/camelcase': 'off',
'@typescript-eslint/explicit-function-return-type': 'off',
'@typescript-eslint/explicit-module-boundary-types': 'off',
'@typescript-eslint/no-empty-interface': 'off',
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-floating-promises': ['error', { ignoreVoid: true }],
'@typescript-eslint/no-inferrable-types': 'off',
'@typescript-eslint/no-namespace': 'off',
'@typescript-eslint/no-non-null-assertion': 'off',
'@typescript-eslint/no-unused-vars': ['warn', { args: 'none' }],
'@typescript-eslint/no-use-before-define': 'off',
'@typescript-eslint/no-var-requires': 'off',
'no-case-declarations': 'warn',
'no-control-regex': 'warn',
'no-inner-declarations': 'off',
'no-prototype-builtins': 'off',
'no-undef': 'warn',
'no-useless-escape': 'off',
'prefer-const': 'off',
'import/no-unresolved': 'off',
// the default, but for reference...
'import/order': [
'warn',
{
groups: [
'builtin',
'external',
'parent',
'sibling',
'index',
'object',
'unknown',
],
pathGroups: [
{ pattern: 'react/**', group: 'builtin', order: 'after' },
{ pattern: 'codemirror/**', group: 'external', order: 'before' },
{ pattern: '@lumino/**', group: 'builtin', order: 'before' },
{ pattern: '@jupyterlab/**', group: 'external', order: 'after' },
],
'newlines-between': 'always',
alphabetize: { order: 'asc' },
},
],
parser: '@typescript-eslint/parser',
parserOptions: {
project: '.eslint.tsconfig.json'
},
plugins: ['@typescript-eslint'],
rules: {
'@typescript-eslint/no-floating-promises': ['error', { ignoreVoid: true }],
'@typescript-eslint/naming-convention': [
'error',
{
selector: 'interface',
format: ['PascalCase'],
custom: {
regex: '^I[A-Z]',
match: true
}
}
],
'@typescript-eslint/no-unused-vars': ['warn', { args: 'none' }],
'@typescript-eslint/no-use-before-define': 'off',
'@typescript-eslint/camelcase': 'off',
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-non-null-assertion': 'off',
'@typescript-eslint/no-namespace': 'off',
'@typescript-eslint/interface-name-prefix': 'off',
'@typescript-eslint/explicit-function-return-type': 'off',
'@typescript-eslint/ban-ts-comment': ['warn', { 'ts-ignore': true }],
'@typescript-eslint/ban-types': 'warn',
'@typescript-eslint/no-non-null-asserted-optional-chain': 'warn',
'@typescript-eslint/no-var-requires': 'off',
'@typescript-eslint/no-empty-interface': 'off',
'@typescript-eslint/triple-slash-reference': 'warn',
'@typescript-eslint/no-inferrable-types': 'off',
'@typescript-eslint/explicit-module-boundary-types': 'off',
'no-inner-declarations': 'off',
'no-prototype-builtins': 'off',
'no-control-regex': 'warn',
'no-undef': 'warn',
'no-case-declarations': 'warn',
'no-useless-escape': 'off',
'prefer-const': 'off'
// deviations from jupyterlab, should probably be fixed
'import/no-cycle': 'off', // somehow we lapsed here... ~200 cycles now
'import/export': 'off', // we do class/interface + NS pun exports _all over_
'@typescript-eslint/triple-slash-reference': 'off',
'no-async-promise-executor': 'off',
'prefer-spread': 'off',
'react/display-name': 'off',
},
settings: {
react: {
version: 'detect',
},
settings: {
react: {
version: 'detect'
}
}
};
},
};
83 changes: 83 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
name: Bug report
about: Create a report to help us improve
labels: bug
---

<!--
Welcome! Before creating a new issue:
* Search for relevant issues
* Follow the issue reporting guidelines:
https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html
-->

## Description

<!--Describe the bug clearly and concisely. Include screenshots (or even better - gifs) if possible-->

## Reproduce

<!--Describe step-by-step instructions to reproduce the behavior-->

1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error '...'

<!--Describe how you diagnosed the issue. See the guidelines at
https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html -->

## Expected behavior

<!--Describe what you expected to happen-->

## Context

<!--Complete the following for context, and add any other relevant context-->

- Operating System and version:
- Browser and version:
- JupyterLab version:
- jupyterlab-fonts version(s):

<details><summary>Required: installed server extensions</summary>
<pre>
Paste the output from running `jupyter server extension list` (JupyterLab >= 3)
or `jupyter serverextension list` (JupyterLab < 3) from the command line here.
You may want to sanitize the paths in the output.
</pre>
</details>

<details><summary>Required: installed lab extensions</summary>
<pre>
Paste the output from running `jupyter labextension list` from the command line here.
You may want to sanitize the paths in the output.
</pre>
</details>

<!--The more content you provide, the more we can help!-->

<details><summary>Troubleshoot Output</summary>
<pre>
Paste the output from running `jupyter troubleshoot` from the command line here.
You may want to sanitize the paths in the output.
</pre>
</details>

<details><summary>Command Line Output</summary>
<pre>
Paste the output from your command line running `jupyter lab` here, use `--debug` if possible.
</pre>
</details>

<details><summary>Browser Output (recommended for all interface issues)</summary>
<pre>
Paste the output from your browser JavaScript console replacing the text in here.

To learn how to open the developer tools in your browser:
https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools#How_to_open_the_devtools_in_your_browser
If too many messages accumulated after many hours of working in JupyterLab, consider
refreshing the window and then reproducing the bug to reduce the noise in the logs.

</pre>
</details>
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Documentation request
about: Ask for clarification in documentation
labels: documentation
---

<!--
Welcome! Before creating a new issue:
* Search for relevant issues
* Follow the issue reporting guidelines:
https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html
-->

## What I am trying to do...

<!-- Describe what you are trying to do, and how the current docs aren't helping you achieve it-->

## How I would like to learn how to do it...

<!--Describe what would help you understand what you are trying to do, e.g. tutorials, code comments, screencasts, etc.-->

## How the project might keep the docs accurate...

<!--Describe how this documentation can be kept up-to-date: testing, link checking, etc. -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Request a Future Roadmap item
about: Help us build future features
labels: enhancement
---

<!--
Welcome! Before creating a new issue:
* Search for relevant issues
* Follow the issue reporting guidelines:
https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html
-->

## Elevator Pitch

<!-- In no more than three sentences, what would you like to see implemented? -->

## Motivation

<!-- Why do you want this feature? -->

## Design Ideas

<!-- Share any kind of design ideas (e.g. ASCII art, links, screenshots) that might help us understand -->
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Release
about: Prepare for a release
labels: maintenance
---

- [ ] merge all outstanding PRs
- [ ] ensure the versions have been bumped (check with `doit`)
- [ ] ensure the CHANGELOG is up-to-date
- [ ] move the new release to the top of the stack
- [ ] validate on binder
- [ ] validate on ReadTheDocs
- [ ] wait for a successful build of `main`
- [ ] download the `dist` archive and unpack somewhere (maybe a fresh `dist`)
- [ ] create a new release through the GitHub UI
- [ ] paste in the relevant CHANGELOG entries
- [ ] upload the artifacts
- [ ] actually upload to npm.com, pypi.org
```bash
cd dist
twine upload *.tar.gz *.whl
npm login
for tarball in deathbeds-jupyterlab-fonts-*.tar.gz; do
npm publish .tgz
done
npm logout
```
- [ ] postmortem
- [ ] handle `conda-forge` feedstock tasks
- [ ] validate on binder via simplest-possible gists
- [ ] bump to next development version
- [ ] update release procedures

0 comments on commit d9178c2

Please sign in to comment.