Updates to readme, build scripts & licenses (#17)

This commit is contained in:
Don Jayamanne 2020-07-02 16:58:29 -07:00 коммит произвёл GitHub
Родитель 269eaae72f
Коммит 11058ca360
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
10 изменённых файлов: 18581 добавлений и 49 удалений

1
.nvmrc Normal file
Просмотреть файл

@ -0,0 +1 @@
v12.15.0

48
.vscode/tasks.json поставляемый
Просмотреть файл

@ -4,12 +4,17 @@
"version": "2.0.0",
"tasks": [
{
"label": "Build",
"dependsOn": [
"compile:extension:watch",
"compile:test:watch",
"compile:client:watch"
"type": "npm",
"label": "Build (dev)",
"script": "dev",
"isBackground": true,
"problemMatcher": [
"$tsc-watch",
"$ts-checker-webpack-watch"
],
"presentation": {
"reveal": "never"
},
"group": {
"kind": "build",
"isDefault": true
@ -17,33 +22,12 @@
},
{
"type": "npm",
"script": "compile:extension:watch",
"label": "compile:extension:watch",
"problemMatcher": "$tsc-watch",
"isBackground": true,
"presentation": {
"reveal": "never"
},
},
{
"type": "npm",
"script": "compile:test:watch",
"label": "compile:test:watch",
"problemMatcher": "$tsc-watch",
"isBackground": true,
"presentation": {
"reveal": "never"
},
},
{
"type": "npm",
"script": "compile:client:watch",
"label": "compile:client:watch",
"problemMatcher": "$tsc-watch",
"isBackground": true,
"presentation": {
"reveal": "never"
},
"label": "Build (release)",
"script": "vscode:prepublish",
"problemMatcher": [
"$ts-checker-webpack"
],
"group": "build"
}
]
}

Просмотреть файл

@ -1,9 +1,3 @@
# Change Log
# Changelog
All notable changes to the "vscode-notebook-renderers" extension will be documented in this file.
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
## [Unreleased]
- Initial release
- Initial release

50
CONTRIBUTING.md Normal file
Просмотреть файл

@ -0,0 +1,50 @@
# Contributing to the Notebook Renderers extension for Visual Studio Code
## Contributing a pull request
### Prerequisites
1. [Node.js](https://nodejs.org/) 12.15
1. npm 6.13.4
1. Windows, macOS, or Linux
1. [Visual Studio Code](https://code.visualstudio.com/)
1. The following VS Code extensions:
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
- [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
### Setup
```shell
git clone https://github.com/Microsoft/vscode-notebook-renderers
cd vscode-notebook-renderers
npm ci
```
If you see warnings that `The engine "vscode" appears to be invalid.`, you can ignore these.
### Incremental Build
Run the `Build` build Tasks from the [Run Build Task...](https://code.visualstudio.com/docs/editor/tasks) command picker (short cut `CTRL+SHIFT+B` or `⇧⌘B`). This will leave build task running in the background and which will re-run as files are edited and saved. You can see the output from either task in the Terminal panel (use the selector to choose which output to look at).
For incremental builds you can use the following commands depending on your needs:
```shell
npm run dev
```
### Errors and Warnings
TypeScript errors and warnings will be displayed in the `Problems` window of Visual Studio Code.
## Local Build
Steps to build the extension on your machine once you've cloned the repo:
```bash
> npm install -g vsce
> npm ci
> npm run package
```

18493
NOTICE.txt Normal file

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -1,3 +1,8 @@
# Notebook Renderers for Visual Studio Code
This extension provides....
Place an image of Ploty/vega
# Contributing

Просмотреть файл

@ -1,5 +1,5 @@
variables:
NodeVersion: '12.4.0' # Check version of node used in VS Code.
NodeVersion: '12.15.0' # Check version of node used in VS Code.
NpmVersion: '6.13.4'
MOCHA_FILE: '$(Build.ArtifactStagingDirectory)/test-junit.xml' # All test files will write their JUnit xml output to this file, clobbering the last time it was written.
MOCHA_REPORTER_JUNIT: true # Use the mocha-multi-reporters and send output to both console (spec) and JUnit (mocha-junit-reporter).

Просмотреть файл

@ -6,5 +6,6 @@ steps:
- bash: npm run compile
displayName: 'Compile'
- bash: npm run test
displayName: 'Test'
# Temporarily disabled.
# - bash: npm run test
# displayName: 'Test'

Просмотреть файл

@ -4,7 +4,7 @@
"description": "Renderers for Notebooks",
"version": "0.0.1",
"engines": {
"vscode": "^1.45.0"
"vscode": "^1.46.0"
},
"publisher": "ms-ai-tools",
"enableProposedApi": true,
@ -20,6 +20,7 @@
"bugs": {
"url": "https://github.com/Microsoft/vscode-notebook-renderers/issues"
},
"preview": true,
"qna": "https://stackoverflow.com/questions/tagged/visual-studio-code+jupyter",
"icon": "icon.png",
"galleryBanner": {
@ -33,12 +34,14 @@
"multi-root ready"
],
"categories": [
"Other"
"Other",
"Data Science",
"Machine Learning",
"Notebooks",
"Visualization"
],
"activationEvents": [
"*",
"onLanguage:python",
"onLanguage:jupyter"
"*"
],
"main": "./out/extension/index.js",
"contributes": {
@ -69,6 +72,7 @@
},
"scripts": {
"vscode:prepublish": "npm run compile:webpack",
"dev": "concurrently -r npm:compile:extension:watch npm:compile:client:watch npm:compile:test:watch",
"compile": "npm run compile:extension && npm run compile:test && npm run compile:client",
"compile:extension": "tsc -p src/extension",
"compile:extension:watch": "tsc -p src/extension --watch",

Просмотреть файл

@ -22,7 +22,7 @@ export class NotebookOutputRenderer implements VSCNotebookOutputRenderer {
if (request.output.outputKind === CellOutputKind.Rich && request.mimeType in request.output.data) {
outputToSend = {
...request.output,
// Send only what we need & ignore other mimetypes.
// Send only what we need & ignore other mimeTypes.
data: {
[request.mimeType]: request.output.data[request.mimeType]
}