Skip to content
GitLab
Unverified Commit ead4b39a authored by Bryn Ryans's avatar Bryn Ryans Committed by GitHub
Browse files

Improve npm packaging (#437) 

* Improve npm packaging

published npm packages now included commonjs and esm distributions.

Further work needs to be done to expose both commonjs and esm in all packages but the packages that need to run in both node and the browser either expose both or commonjs rather than esm.
parent 3446d6b4
Hide whitespace changes
Inline Side-by-side
Showing
with 63 additions and 76 deletions
+63 -76
babel.config.js
+ 5
- 2
View file @ ead4b39a
......@@ -67,13 +67,16 @@ module.exports = (api) => {
esmodules: true,
},
useBuiltIns: false,
modules: false,
modules: process.env.BABEL_ENV === 'build_cjs' ? 'auto' : false,
},
],
[
'@babel/preset-react',
{
development: process.env.BABEL_ENV !== 'build',
development: !(
process.env.BABEL_ENV === 'build' ||
process.env.BABEL_ENV === 'build_cjs'
),
},
],
'@babel/preset-typescript',
......
examples/access-token-server/package.json
+ 2
- 1
View file @ ead4b39a
......@@ -11,7 +11,8 @@
"create-status-json": "ts-node script/create_status_json.ts"
},
"dependencies": {
"@looker/sdk": "^0.3.7-beta.5",
"@looker/sdk": "7.20.3",
"@looker/sdk-rtl": "7.20.3",
"body-parser": "^1.19.0",
"crypto-js": "^4.0.0",
"dotenv": "^8.2.0",
......
lerna.json
+ 1
- 1
View file @ ead4b39a
......@@ -4,5 +4,5 @@
],
"npmClient": "yarn",
"useWorkspaces": true,
"version": "7.20.2"
"version": "7.20.3"
}
package.json
+ 7
- 3
View file @ ead4b39a
......@@ -32,7 +32,8 @@
"wipe": "rm -rf api spec",
"prebuild": "yarn clean",
"build": "run-p -c build:*",
"build:es": "yarn lerna exec --stream 'BABEL_ENV=build babel src --root-mode upward --out-dir lib --source-maps --extensions .ts,.tsx --no-comments'",
"build:cjs": "yarn lerna exec --stream 'BABEL_ENV=build_cjs babel src --root-mode upward --out-dir lib --source-maps --extensions .ts,.tsx --no-comments'",
"build:es": "yarn lerna exec --stream 'BABEL_ENV=build babel src --root-mode upward --out-dir lib/esm --source-maps --extensions .ts,.tsx --no-comments'",
"build:ts": "yarn lerna exec --stream --sort 'tsc -b tsconfig.build.json'",
"clean": "rm -Rf packages/*/lib",
"prepublishOnly": "yarn jest packages/sdk/",
......@@ -162,8 +163,11 @@
"sort-keys": "off",
"spaced-comment": [
"error",
"always", {
"markers": ["#"]
"always",
{
"markers": [
"#"
]
}
]
},
......
packages/api-explorer/package.json
+ 7
- 7
View file @ ead4b39a
{
"name": "@looker/api-explorer",
"version": "7.20.2",
"version": "7.20.3",
"description": "Looker API Explorer",
"main": "lib/index.js",
"main": "lib/esm/index.js",
"typings": "lib/index.d.ts",
"license": "MIT",
"author": "Looker",
......@@ -26,7 +26,7 @@
},
"devDependencies": {
"@looker/components-test-utils": "^0.9.29",
"@looker/sdk-codegen-scripts": "^7.20.2",
"@looker/sdk-codegen-scripts": "^7.20.3",
"@testing-library/jest-dom": "^5.11.6",
"@testing-library/react": "^11.2.2",
"@testing-library/user-event": "^12.6.0",
......@@ -45,10 +45,10 @@
},
"dependencies": {
"@looker/components": "^0.9.30",
"@looker/run-it": "^7.20.2",
"@looker/sdk": "^7.20.2",
"@looker/sdk-codegen": "^7.20.2",
"@looker/sdk-rtl": "^7.20.1",
"@looker/run-it": "^7.20.3",
"@looker/sdk": "^7.20.3",
"@looker/sdk-codegen": "^7.20.3",
"@looker/sdk-rtl": "^7.20.3",
"ace": "^1.3.0",
"ace-builds": "^1.4.11",
"history": "^4.10.1",
......
packages/extension-api-explorer/package.json
+ 5
- 5
View file @ ead4b39a
{
"name": "@looker/extension-api-explorer",
"version": "7.20.2",
"version": "7.20.3",
"description": "Looker API Explorer extension version ",
"main": "index.js",
"main": "esm/index.js",
"license": "MIT",
"private": true,
"homepage": "https://github.com/looker-open-source/sdk-codegen/tree/master/packages/extension-api-explorer",
......@@ -13,11 +13,11 @@
"watch": "yarn lerna exec --scope @looker/extension-api-explorer --stream 'BABEL_ENV=build babel src --root-mode upward --out-dir lib --source-maps --extensions .ts,.tsx --no-comments --watch'"
},
"dependencies": {
"@looker/api-explorer": "^7.20.2",
"@looker/api-explorer": "^7.20.3",
"@looker/extension-sdk": "^0.13.0-alpha.1",
"@looker/extension-sdk-react": "^0.7.0-alpha.1",
"@looker/run-it": "^7.20.2",
"@looker/sdk": "^7.20.2",
"@looker/run-it": "^7.20.3",
"@looker/sdk": "^7.20.3",
"react": "^16.13.1",
"react-dom": "^16.13.1",
"react-router-dom": "^5.2.0",
......
packages/hackathon/package.json
+ 5
- 5
View file @ ead4b39a
{
"name": "@looker/hackathon",
"version": "7.20.2",
"version": "7.20.3",
"description": "Looker Hackathon extension",
"main": "lib/index.js",
"main": "lib/esm/index.js",
"typings": "lib/index.d.ts",
"files": [
"lib"
......@@ -36,9 +36,9 @@
"@looker/components": "^0.9.30",
"@looker/extension-sdk": "^0.13.0-alpha.1",
"@looker/extension-sdk-react": "^0.7.0-alpha.1",
"@looker/sdk": "^7.20.2",
"@looker/sdk-rtl": "^7.20.1",
"@looker/wholly-sheet": "^7.20.2",
"@looker/sdk": "^7.20.3",
"@looker/sdk-rtl": "^7.20.3",
"@looker/wholly-sheet": "^7.20.3",
"lodash": "^4.17.20",
"react": "^16.13.1",
"react-dom": "^16.13.1",
......
packages/run-it/package.json
+ 6
- 6
View file @ ead4b39a
{
"name": "@looker/run-it",
"version": "7.20.2",
"version": "7.20.3",
"description": "A dynamic REST request input form and response visualizer",
"main": "lib/index.js",
"main": "lib/esm/index.js",
"typings": "lib/index.d.ts",
"files": [
"lib"
......@@ -46,10 +46,10 @@
"dependencies": {
"@looker/components": "^0.9.30",
"@looker/design-tokens": "0.9.27",
"@looker/sdk": "^7.20.2",
"@looker/sdk-codegen": "^7.20.2",
"@looker/sdk-codegen-utils": "^7.20.1",
"@looker/sdk-rtl": "^7.20.1",
"@looker/sdk": "^7.20.3",
"@looker/sdk-codegen": "^7.20.3",
"@looker/sdk-codegen-utils": "^7.20.3",
"@looker/sdk-rtl": "^7.20.3",
"@types/readable-stream": "^2.3.5",
"lodash": "^4.17.19",
"papaparse": "^5.3.0",
......
packages/sdk-codegen-scripts/package.json
+ 5
- 5
View file @ ead4b39a
{
"name": "@looker/sdk-codegen-scripts",
"version": "7.20.2",
"version": "7.20.3",
"description": "Looker SDK Codegen scripts",
"main": "lib/index.js",
"typings": "lib/index.d.ts",
......@@ -27,10 +27,10 @@
"watch": "yarn lerna exec --scope @looker/sdk-codegen-scripts --stream 'BABEL_ENV=build babel src --root-mode upward --out-dir lib --source-maps --extensions .ts,.tsx --no-comments --watch'"
},
"dependencies": {
"@looker/sdk": "^7.20.2",
"@looker/sdk-codegen": "^7.20.2",
"@looker/sdk-codegen-utils": "^7.20.1",
"@looker/sdk-rtl": "^7.20.1",
"@looker/sdk": "^7.20.3",
"@looker/sdk-codegen": "^7.20.3",
"@looker/sdk-codegen-utils": "^7.20.3",
"@looker/sdk-rtl": "^7.20.3",
"config": "^3.3.1",
"cross-env": "^7.0.2"
},
......
packages/sdk-codegen-utils/package.json
+ 1
- 1
View file @ ead4b39a
{
"name": "@looker/sdk-codegen-utils",
"version": "7.20.1",
"version": "7.20.3",
"description": "Looker SDK Codegen utils",
"main": "lib/index.js",
"typings": "lib/index.d.ts",
......
packages/sdk-codegen-utils/src/utils.ts
+ 3
- 1
View file @ ead4b39a
......@@ -37,7 +37,7 @@ const FgGreen = '\x1b[32m'
const FgYellow = '\x1b[33m'
// const FgBlue = "\x1b[34m"
// const FgMagenta = "\x1b[35m"
// const FgCyan = "\x1b[36m"
const FgCyan = '\x1b[36m'
// const FgWhite = "\x1b[37m"
//
// const BgBlack = "\x1b[40m"
......@@ -57,6 +57,8 @@ export const log = (message?: any) => {
const reset = (message: any) => `${message}${Reset}`
export const info = (message: any) => log(reset(`${FgCyan}${message}`))
export const warn = (message: any) => log(reset(`${FgYellow}${message}`))
export const danger = (message: any) => {
......
packages/sdk-codegen/package.json
+ 4
- 4
View file @ ead4b39a
{
"name": "@looker/sdk-codegen",
"version": "7.20.2",
"version": "7.20.3",
"description": "Looker SDK Codegen core",
"main": "lib/index.js",
"typings": "lib/index.d.ts",
......@@ -32,9 +32,9 @@
"watch": "yarn lerna exec --scope @looker/sdk-codegen --stream 'BABEL_ENV=build babel src --root-mode upward --out-dir lib --source-maps --extensions .ts,.tsx --no-comments --watch'"
},
"dependencies": {
"@looker/sdk": "^7.20.2",
"@looker/sdk-codegen-utils": "^7.20.1",
"@looker/sdk-rtl": "^7.20.1",
"@looker/sdk": "^7.20.3",
"@looker/sdk-codegen-utils": "^7.20.3",
"@looker/sdk-rtl": "^7.20.3",
"blueimp-md5": "^2.13.0",
"openapi3-ts": "^1.3.0"
},
......
packages/sdk-rtl/README.md
+ 0
- 13
View file @ ead4b39a
......@@ -7,16 +7,3 @@ The source code in this package is almost all completely generic REST request/re
The `@looker/sdk` package is updated with every Looker release. This package has a much longer update/release cycle.
**DISCLAIMER**: This is a _beta_ version of the Looker SDK runtime library. Implementations are still subject to change.
## Using jest tests with this SDK as a dependency
This jest config entry may be required to run jest tests on projects which depend on this package.
```js
transform: {
'^.+\\.(js|ts|tsx)?$': 'ts-jest',
},
transformIgnorePatterns: [
'<rootDir>/node_modules/(?!@looker/(sdk-rtl|sdk)/.*)',
],
```
packages/sdk-rtl/package.json
+ 2
- 2
View file @ ead4b39a
{
"name": "@looker/sdk-rtl",
"version": "7.20.1",
"version": "7.20.3",
"description": "Looker SDK Runtime Library",
"main": "lib/index.js",
"module": "lib/index.js",
"module": "lib/esm/index.js",
"sideEffects": "false",
"typings": "lib/index.d.ts",
"files": [
......
packages/sdk-rtl/src/platformServices.ts
+ 3
- 0
View file @ ead4b39a
......@@ -28,6 +28,9 @@ import { IApiSettings } from './apiSettings'
import { ITransport } from './transport'
import { ICryptoHash } from './cryptoHash'
/**
* Contract for OAuth authentication services
*/
export interface IPlatformServices {
settings: IApiSettings
transport: ITransport
......
packages/sdk/README.md
+ 0
- 13
View file @ ead4b39a
......@@ -327,16 +327,3 @@ Looker's open source repository of [SDK Examples](https://github.com/looker-open
## A note about security
Any script or configuration file used to provide credentials to your Looker SDK instance [needs to be secured](https://github.com/looker-open-source/sdk-codegen#securing-your-sdk-credentials).
## Using jest tests with this SDK as a dependency
This jest config entry may be required to run jest tests on projects which depend on this package.
```js
transform: {
'^.+\\.(js|ts|tsx)?$': 'ts-jest',
},
transformIgnorePatterns: [
'<rootDir>/node_modules/(?!@looker/(sdk-rtl|sdk)/.*)',
],
```
packages/sdk/package.json
+ 3
- 3
View file @ ead4b39a
{
"name": "@looker/sdk",
"version": "7.20.2",
"version": "7.20.3",
"description": "Looker SDK",
"main": "lib/index.js",
"module": "lib/index.js",
"module": "lib/esm/index.js",
"sideEffects": "false",
"typings": "lib/index.d.ts",
"files": [
......@@ -42,7 +42,7 @@
"@types/request-promise-native": "^1.0.17"
},
"dependencies": {
"@looker/sdk-rtl": "^7.20.1",
"@looker/sdk-rtl": "^7.20.3",
"ini": "^1.3.8",
"readable-stream": "^3.4.0",
"request": "^2.88.0",
......
packages/wholly-sheet/package.json
+ 4
- 4
View file @ ead4b39a
{
"name": "@looker/wholly-sheet",
"version": "7.20.2",
"version": "7.20.3",
"description": "Google sheets API wrapper for data table mimicking",
"main": "lib/index.js",
"main": "lib/esm/index.js",
"typings": "lib/index.d.ts",
"files": [
"lib"
......@@ -31,8 +31,8 @@
"watch": "yarn lerna exec --scope @looker/wholly-sheet --stream 'BABEL_ENV=build babel src --root-mode upward --out-dir lib --source-maps --extensions .ts,.tsx --no-comments --watch'"
},
"dependencies": {
"@looker/sdk": "^7.20.2",
"@looker/sdk-rtl": "^7.20.1",
"@looker/sdk": "^7.20.3",
"@looker/sdk-rtl": "^7.20.3",
"lodash": "^4.17.20",
"uuid": "^8.3.1"
},
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment