-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Azure Quantum SDK for Azure SDK for JS #13345
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
2ae3027
a596294
60e9019
799cc1b
cf421dc
dfa84bc
d12c5f6
d5c8453
fe346a0
105e40e
42e2666
d19ed97
6874bca
1be908c
b567d3b
e752670
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| The MIT License (MIT) | ||
|
|
||
| Copyright (c) 2021 Microsoft | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| ## Azure QuantumClient client library for JavaScript | ||
|
|
||
| This package contains an isomorphic SDK for QuantumClient. | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Install the package | ||
|
|
||
| ```bash | ||
| npm install @azure/quantum | ||
| ``` | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Node.js version 8.x.x or higher | ||
|
|
||
| ## Key concepts | ||
|
|
||
| **TO BE FILLED** | ||
|
|
||
| ## Examples | ||
|
|
||
| **TO BE FILLED** | ||
|
|
||
| ## Next steps | ||
|
|
||
| **TO BE FILLED** | ||
|
|
||
| ## Contributing | ||
|
|
||
| **TO BE FILLED** | ||
|
|
||
| ## Related projects | ||
|
|
||
| **TO BE FILLED** | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| **TO BE FILLED** | ||
|
|
||
|  |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | ||
| "mainEntryPointFilePath": "./types/index.d.ts", | ||
| "docModel": { "enabled": true }, | ||
| "apiReport": { "enabled": true, "reportFolder": "./review" }, | ||
| "dtsRollup": { | ||
| "enabled": true, | ||
| "untrimmedFilePath": "", | ||
| "publicTrimmedFilePath": "./esm/index.d.ts" | ||
| }, | ||
| "messages": { | ||
| "tsdocMessageReporting": { "default": { "logLevel": "none" } }, | ||
| "extractorMessageReporting": { | ||
| "ae-missing-release-tag": { "logLevel": "none" }, | ||
| "ae-unresolved-link": { "logLevel": "none" } | ||
| } | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| { | ||
| "name": "@azure/quantum", | ||
| "author": "Microsoft Corporation", | ||
| "description": "Azure Quantum REST API client", | ||
| "version": "1.0.0-beta.1", | ||
| "dependencies": { | ||
| "@azure/core-paging": "^1.1.1", | ||
| "@azure/core-http": "^1.2.0", | ||
| "tslib": "^2.0.0" | ||
| }, | ||
| "keywords": [ | ||
| "node", | ||
| "azure", | ||
| "typescript", | ||
| "browser", | ||
| "isomorphic" | ||
| ], | ||
| "license": "MIT", | ||
| "main": "./dist/quantum.js", | ||
| "module": "./esm/index.js", | ||
| "types": "./esm/index.d.ts", | ||
| "devDependencies": { | ||
| "typescript": "4.1.2", | ||
| "rollup": "^1.16.3", | ||
| "rollup-plugin-node-resolve": "^3.4.0", | ||
| "rollup-plugin-sourcemaps": "^0.4.2", | ||
| "uglify-js": "^3.4.9", | ||
| "@microsoft/api-extractor": "7.7.11", | ||
| "mkdirp": "^1.0.4" | ||
| }, | ||
| "homepage": "https://github.com/Azure/azure-sdk-for-js", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/Azure/azure-sdk-for-js.git" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/Azure/azure-sdk-for-js/issues" | ||
| }, | ||
| "files": [ | ||
| "dist/**/*.js", | ||
| "dist/**/*.js.map", | ||
| "dist/**/*.d.ts", | ||
| "dist/**/*.d.ts.map", | ||
| "esm/**/*.js", | ||
| "esm/**/*.js.map", | ||
| "esm/**/*.d.ts", | ||
| "esm/**/*.d.ts.map", | ||
| "./src//**/*.ts", | ||
| "README.md", | ||
| "rollup.config.js", | ||
| "tsconfig.json" | ||
| ], | ||
| "scripts": { | ||
| "build": "tsc && rollup -c rollup.config.js && mkdirp ./review && npm run extract-api", | ||
| "clean": "rimraf dist dist-esm dist-browser test-dist test-browser types *.tgz *.log", | ||
| "extract-api": "api-extractor run --local", | ||
| "build:samples": "echo skip", | ||
| "build:node": "echo skip", | ||
| "build:browser": "echo skip", | ||
| "build:test": "echo skip", | ||
| "build:test:node": "echo skip", | ||
| "build:test:browser": "echo skip", | ||
| "check-format": "echo skip", | ||
| "coverage": "echo skip", | ||
| "execute:samples": "echo skip", | ||
| "format": "echo skip", | ||
| "lint:fix": "echo skip", | ||
| "lint": "echo skip", | ||
| "prebuild": "echo skip", | ||
| "pack": "echo skip", | ||
| "swagger": "echo skip", | ||
| "integration-test": "echo skip", | ||
| "integration-test:browser": "echo skip", | ||
| "integration-test:node": "echo skip", | ||
| "test": "echo skip", | ||
| "test:browser": "echo skip", | ||
| "test:node": "echo skip", | ||
| "unit-test": "echo skip", | ||
| "unit-test:browser": "echo skip", | ||
| "unit-test:node": "echo skip", | ||
| "docs": "echo skip" | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. any reason we cannot fill the above scripts like we have for other packages rather than keeping them as
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I see that you answered in #13345 (comment), I have replied there as well :)
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The CI actually tries to run them and without actual tests they will fail. Also, we need to ensure each script runs before proceeding forward. Since this is a first commit, I made it to skip |
||
| }, | ||
| "sideEffects": false | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once the
reviewdirectory is created in the initial commit, we don't have to recreate it every time the package is built right?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The review directory will be created only if it doesn't exist.