Optimized package.json files (grafana#22475)

* Used repository shortcut syntax where possible * Added repository directories for monorepo packages * Alphabetically sorted npm scripts
AmyBlankenship · Feb 27, 2020 · 2b6a88b · 2b6a88b
1 parent 63c6fc5
commit 2b6a88b
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 59 deletions.
diff --git a/package.json b/package.json
@@ -4,10 +4,7 @@
   "private": true,
   "name": "grafana",
   "version": "6.7.0-pre",
-  "repository": {
-    "type": "git",
-    "url": "http://github.com/grafana/grafana.git"
-  },
+  "repository": "github:grafana/grafana",
   "devDependencies": {
     "@babel/core": "7.8.4",
     "@babel/plugin-proposal-nullish-coalescing-operator": "7.8.3",
@@ -154,40 +151,40 @@
     "zone.js": "0.7.8"
   },
   "scripts": {
-    "dev": "webpack --progress --colors --config scripts/webpack/webpack.dev.js",
-    "start": "grafana-toolkit core:start --watchTheme",
-    "start:hot": "grafana-toolkit core:start --hot --watchTheme",
-    "start:ignoreTheme": "grafana-toolkit core:start --hot",
-    "start:noTsCheck": "grafana-toolkit core:start --noTsCheck",
-    "stats": "webpack --mode production --config scripts/webpack/webpack.prod.js --profile --json > compilation-stats.json",
-    "watch": "yarn start -d watch,start core:start --watchTheme ",
+    "api-tests": "jest --notify --watch --config=devenv/e2e-api-tests/jest.js",
     "build": "grunt build",
-    "test": "grunt test",
-    "lint": "eslint public/app public/e2e-test public/test --ext=.js,.ts,.tsx",
-    "lint:fix": "yarn lint --fix",
-    "typecheck": "tsc --noEmit",
-    "jest": "jest --notify --watch",
-    "jest-ci": "mkdir -p reports/junit && export JEST_JUNIT_OUTPUT_DIR=reports/junit && jest --ci --reporters=default --reporters=jest-junit --maxWorkers 2",
+    "dev": "webpack --progress --colors --config scripts/webpack/webpack.dev.js",
     "e2e": "cd packages/grafana-e2e && yarn start --env BASE_URL=$BASE_URL,CIRCLE_SHA1=$CIRCLE_SHA1,SLOWMO=$SLOWMO --config integrationFolder=../../public/e2e-tests/integration,screenshotsFolder=../../public/e2e-tests/screenShots,videosFolder=../../public/e2e-tests/videos,fileServerFolder=./cypress,viewportWidth=1920,viewportHeight=1080,trashAssetsBeforeRuns=false",
     "e2e-tests": "yarn e2e",
     "e2e-tests:debug": "SLOWMO=1 yarn e2e --headed --no-exit",
-    "api-tests": "jest --notify --watch --config=devenv/e2e-api-tests/jest.js",
-    "storybook": "cd packages/grafana-ui && yarn storybook --ci",
-    "storybook:build": "cd packages/grafana-ui && yarn storybook:build",
-    "prettier:check": "prettier --list-different \"**/*.{ts,tsx,scss}\"",
-    "prettier:write": "prettier --list-different \"**/*.{ts,tsx,scss}\" --write",
-    "precommit": "grafana-toolkit precommit",
-    "themes:generate": "ts-node --project ./scripts/cli/tsconfig.json ./scripts/cli/generateSassVariableFiles.ts",
+    "jest": "jest --notify --watch",
+    "jest-ci": "mkdir -p reports/junit && export JEST_JUNIT_OUTPUT_DIR=reports/junit && jest --ci --reporters=default --reporters=jest-junit --maxWorkers 2",
+    "lint": "eslint public/app public/e2e-test public/test --ext=.js,.ts,.tsx",
+    "lint:fix": "yarn lint --fix",
+    "packages:build": "lerna run clean && lerna run build",
+    "packages:docsExtract": "rm -rf ./scripts/docs && lerna run docsExtract",
+    "packages:docsToMarkdown": "api-documenter markdown --input-folder ./reports/docs/ --output-folder ./docs/sources/packages_api/ --hugo --draft",
     "packages:lint": "lerna run lint",
-    "packages:typecheck": "lerna run typecheck",
     "packages:prepare": "lerna version --no-push --no-git-tag-version --force-publish --exact",
-    "packages:build": "lerna run clean && lerna run build",
     "packages:publish": "lerna publish from-package --contents dist",
+    "packages:publishCanary": "lerna publish from-package --contents dist --dist-tag canary --yes",
     "packages:publishLatest": "lerna publish from-package --contents dist --yes",
     "packages:publishNext": "lerna publish from-package --contents dist --dist-tag next --yes",
-    "packages:publishCanary": "lerna publish from-package --contents dist --dist-tag canary --yes",
-    "packages:docsExtract": "rm -rf ./scripts/docs && lerna run docsExtract",
-    "packages:docsToMarkdown": "api-documenter markdown --input-folder ./reports/docs/ --output-folder ./docs/sources/packages_api/ --hugo --draft"
+    "packages:typecheck": "lerna run typecheck",
+    "precommit": "grafana-toolkit precommit",
+    "prettier:check": "prettier --list-different \"**/*.{ts,tsx,scss}\"",
+    "prettier:write": "prettier --list-different \"**/*.{ts,tsx,scss}\" --write",
+    "start": "grafana-toolkit core:start --watchTheme",
+    "start:hot": "grafana-toolkit core:start --hot --watchTheme",
+    "start:ignoreTheme": "grafana-toolkit core:start --hot",
+    "start:noTsCheck": "grafana-toolkit core:start --noTsCheck",
+    "stats": "webpack --mode production --config scripts/webpack/webpack.prod.js --profile --json > compilation-stats.json",
+    "storybook": "cd packages/grafana-ui && yarn storybook --ci",
+    "storybook:build": "cd packages/grafana-ui && yarn storybook:build",
+    "test": "grunt test",
+    "themes:generate": "ts-node --project ./scripts/cli/tsconfig.json ./scripts/cli/generateSassVariableFiles.ts",
+    "typecheck": "tsc --noEmit",
+    "watch": "yarn start -d watch,start core:start --watchTheme "
   },
   "husky": {
     "hooks": {

diff --git a/packages/grafana-data/package.json b/packages/grafana-data/package.json
@@ -9,17 +9,18 @@
   ],
   "repository": {
     "type": "git",
-    "url": "http://github.com/grafana/grafana.git"
+    "url": "http://github.com/grafana/grafana.git",
+    "directory": "packages/grafana-data"
   },
   "main": "src/index.ts",
   "types": "src/index.ts",
   "scripts": {
-    "lint": "eslint src/ --ext=.js,.ts,.tsx",
-    "typecheck": "tsc --noEmit",
-    "clean": "rimraf ./dist ./compiled",
-    "bundle": "rollup -c rollup.config.ts",
     "build": "grafana-toolkit package:build --scope=data",
-    "docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log"
+    "bundle": "rollup -c rollup.config.ts",
+    "clean": "rimraf ./dist ./compiled",
+    "docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log",
+    "lint": "eslint src/ --ext=.js,.ts,.tsx",
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "apache-arrow": "0.15.1",

diff --git a/packages/grafana-e2e/README.md b/packages/grafana-e2e/README.md
@@ -1,4 +1,4 @@
-# Grafana End to End Test library
+# Grafana End-to-End Test library
 
 > **@grafana/e2e is currently in ALPHA**. Core API is unstable and can be a subject of breaking changes!
 

diff --git a/packages/grafana-e2e/package.json b/packages/grafana-e2e/package.json
@@ -3,26 +3,27 @@
   "license": "Apache-2.0",
   "name": "@grafana/e2e",
   "version": "6.7.0-pre",
-  "description": "Grafana End to End Test Library",
+  "description": "Grafana End-to-End Test Library",
   "keywords": [
     "grafana",
     "e2e",
     "typescript"
   ],
   "repository": {
     "type": "git",
-    "url": "http://github.com/grafana/grafana.git"
+    "url": "http://github.com/grafana/grafana.git",
+    "directory": "packages/grafana-e2e"
   },
   "main": "src/index.ts",
   "scripts": {
-    "lint": "eslint cypress/ src/ --ext=.js,.ts,.tsx",
-    "typecheck": "tsc --noEmit",
-    "clean": "rimraf ./dist ./compiled",
-    "bundle": "rollup -c rollup.config.ts",
     "build": "grafana-toolkit package:build --scope=e2e",
+    "bundle": "rollup -c rollup.config.ts",
+    "clean": "rimraf ./dist ./compiled",
+    "docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log",
+    "lint": "eslint cypress/ src/ --ext=.js,.ts,.tsx",
     "open": "cypress open",
     "start": "cypress run",
-    "docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log"
+    "typecheck": "tsc --noEmit"
   },
   "devDependencies": {
     "@cypress/webpack-preprocessor": "4.1.1",

diff --git a/packages/grafana-runtime/package.json b/packages/grafana-runtime/package.json
@@ -10,16 +10,17 @@
   ],
   "repository": {
     "type": "git",
-    "url": "http://github.com/grafana/grafana.git"
+    "url": "http://github.com/grafana/grafana.git",
+    "directory": "packages/grafana-runtime"
   },
   "main": "src/index.ts",
   "scripts": {
-    "lint": "eslint src/ --ext=.js,.ts,.tsx",
-    "typecheck": "tsc --noEmit",
-    "clean": "rimraf ./dist ./compiled",
-    "bundle": "rollup -c rollup.config.ts",
     "build": "grafana-toolkit package:build --scope=runtime",
-    "docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log"
+    "bundle": "rollup -c rollup.config.ts",
+    "clean": "rimraf ./dist ./compiled",
+    "docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log",
+    "lint": "eslint src/ --ext=.js,.ts,.tsx",
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "@grafana/data": "6.7.0-pre",

diff --git a/packages/grafana-toolkit/package.json b/packages/grafana-toolkit/package.json
@@ -12,17 +12,18 @@
   ],
   "repository": {
     "type": "git",
-    "url": "http://github.com/grafana/grafana.git"
+    "url": "http://github.com/grafana/grafana.git",
+    "directory": "packages/grafana-toolkit"
   },
   "bin": {
     "grafana-toolkit": "./bin/grafana-toolkit.js"
   },
   "scripts": {
+    "build": "grafana-toolkit toolkit:build",
+    "clean": "rimraf ./dist ./compiled",
     "lint": "eslint src/ --ext=.js,.ts,.tsx",
-    "typecheck": "tsc --noEmit",
     "precommit": "npm run lint & npm run typecheck",
-    "clean": "rimraf ./dist ./compiled",
-    "build": "grafana-toolkit toolkit:build"
+    "typecheck": "tsc --noEmit"
   },
   "main": "src/index.ts",
   "dependencies": {

diff --git a/packages/grafana-ui/package.json b/packages/grafana-ui/package.json
@@ -12,18 +12,19 @@
   ],
   "repository": {
     "type": "git",
-    "url": "http://github.com/grafana/grafana.git"
+    "url": "http://github.com/grafana/grafana.git",
+    "directory": "packages/grafana-ui"
   },
   "main": "src/index.ts",
   "scripts": {
+    "build": "grafana-toolkit package:build --scope=ui",
+    "bundle": "rollup -c rollup.config.ts",
+    "clean": "rimraf ./dist ./compiled",
+    "docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log",
     "lint": "eslint .storybook/ src/ --ext=.js,.ts,.tsx",
-    "typecheck": "tsc --noEmit",
     "storybook": "start-storybook -p 9001 -c .storybook -s .storybook/static",
     "storybook:build": "build-storybook -o ./dist/storybook -c .storybook -s .storybook/static",
-    "clean": "rimraf ./dist ./compiled",
-    "bundle": "rollup -c rollup.config.ts",
-    "build": "grafana-toolkit package:build --scope=ui",
-    "docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log"
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "@grafana/data": "6.7.0-pre",