Rename ./scripts -> ./tool; use only local npm packages (#1133)

* Only use local npm packages

* Rename ./scripts -> ./tool

* Adjust README and scripts: use new tool/ path

Author: chalin

.gitignore

@@ -17,7 +17,7 @@ _site/
 build
 node_modules/
 pubspec.lock
-scripts/packages
+
 # We haven't had any issues due to npm (sub-)package version discrepancies,
 # so we'll ignore the npm lock file for now.
 package-lock.json

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "site-shared"]
   path = site-shared
   url = https://github.com/dart-lang/site-shared.git
-  branch = chalin-bootstrap-4-0823
+  branch = master

.travis.yml

@@ -1,5 +1,5 @@
 language: dart
-dart: stable
+dart: [stable, dev]
 
 cache:
   timeout: 300
@@ -15,29 +15,28 @@ env:
     - JEKYLL_ENV=production
     - TZ=US/Pacific # normalize build timestamp
   matrix:
-    - TASK="./scripts/check-code.sh"
-    - TASK="./scripts/analyze-and-test-examples.sh"
+    - TASK="./tool/check-code.sh"
+    - TASK="./tool/analyze-and-test-examples.sh"
     - TASK="bundle exec jekyll build"
 
 matrix:
-  # Once we start building under stable again, reactivate the following exclusion:
-  # exclude:
-  #   - env: TASK="bundle exec jekyll build"
-  #     dart: dev
+  exclude:
+    - env: TASK="bundle exec jekyll build"
+      dart: dev
 
 before_install:
-  - source ./scripts/env-set.sh
-  - ./scripts/before-install.sh
+  - source ./tool/env-set.sh
+  - ./tool/before-install.sh
 
 install:
-  - ./scripts/install.sh
-  - ./scripts/write-ci-info.sh -v
+  - ./tool/install.sh
+  - ./tool/write-ci-info.sh -v
 
 script:
   - $TASK
 
 after_script:
-  - if [[ $TASK == *build* ]]; then ./scripts/shared/check-links.sh || travis_terminate 1; fi
+  - if [[ $TASK == *build* ]]; then ./tool/shared/check-links.sh || travis_terminate 1; fi
   # Just FYI test. Won't fail the build if it has errors.
   # - if [[ $TASK == *build* ]]; then ./deploy/check_sitemap.rb; fi
   # - if [[ $TASK == *build* ]]; then ./deploy/html_proof.rb; fi

README.md

@@ -54,11 +54,11 @@ if you already have the required packages installed.
 
 1. <code>cd <i>\<path-to-this-repo></i></code> &nbsp;&nbsp;# change to
    **root of this repo**
-1. `source ./scripts/env-set.sh` &nbsp;&nbsp;#
+1. `source ./tool/env-set.sh` &nbsp;&nbsp;#
    initialize environment variables; install/use required Node & Ruby version
-1. `./scripts/before-install.sh` &nbsp;&nbsp;#
+1. `./tool/before-install.sh` &nbsp;&nbsp;#
    install core set of required tools
-1. `./scripts/install.sh` &nbsp;&nbsp;#
+1. `./tool/install.sh` &nbsp;&nbsp;#
    install everything else needed to build this site
 
 > IMPORTANT:
@@ -74,7 +74,7 @@ Once everything is installed, you need to do a full site build at least once:
 
 The generated site is placed in the `site.g` folder. To serve this folder use:
 
-- `superstatic --port 4000`
+- `npx superstatic --port 4000`
 
 Or, if you aren't testing redirects, use this command (which has the bonus of
 autorefreshing your browser after edits):
@@ -85,14 +85,14 @@ To view the generated site open [localhost:4000](http://localhost:4000) in a bro
 
 You can build, serve, and have a watcher for changes by running the following command:
 
-- `./scripts/serve.sh`
+- `./tool/serve.sh`
 
 ## Pre-push checks
 
 If you've made changes to this site's documentation and committed locally, then
 run the following command before pushing your work:
 
-    ./scripts/pre-push.sh
+    ./tool/pre-push.sh
 
 If the script reports errors or warnings, then address the issues and rerun the
 script. Otherwise, you can push your changes.
@@ -103,9 +103,9 @@ script. Otherwise, you can push your changes.
 
 If you've made changes to the example code run the following commands:
 
-- `./scripts/dartfmt.sh`
-- `./scripts/refresh-code-excerpts.sh`
-- `./scripts/analyze-and-test-examples.sh -q`
+- `./tool/dartfmt.sh`
+- `./tool/refresh-code-excerpts.sh`
+- `./tool/analyze-and-test-examples.sh -q`
 
 If the last command reports failed tests and you'd like to know which
 test failed, then rerun the command without the `-q` flag.
@@ -115,7 +115,7 @@ test failed, then rerun the command without the `-q` flag.
 First, build the site and launch the server:
 
 ```
-jekyll build && superstatic --port 4000
+jekyll build && npx superstatic --port 4000
 ```
 
 Next, to check for broken links,

examples/README.md

@@ -44,7 +44,7 @@ dartanalyzer .
 To run both the analyzer and tests:
 
 ```
-./scripts/analyze-and-test-examples.sh
+./tool/analyze-and-test-examples.sh
 ```
 
 If you get a warning about test failures or analysis errors,
@@ -53,11 +53,11 @@ you might need to update one or more analyzer results files
 
 To update an analyzer results file:
 
-1. Run `./scripts/analyze-and-test-examples.sh  --save-logs`.
+1. Run `./tool/analyze-and-test-examples.sh  --save-logs`.
 2. Look at the diffs for the results files.
 3. If the diffs look good but some comments are missing,
    add back the comments that are still relevant.
-4. Run `./scripts/analyze-and-test-examples.sh` to confirm that
+4. Run `./tool/analyze-and-test-examples.sh` to confirm that
    your changes are good.
 
 
@@ -121,7 +121,7 @@ will display as
 
 The code excerpt extractor can apply regular-expression-based replace transformations.
 There are global transformations applied to all code excerpts. See
-`./scripts/refresh-code-excerpts.sh` for an annotated list of replace expressions passed
+`./tool/refresh-code-excerpts.sh` for an annotated list of replace expressions passed
 along with the `--replace` command line argument of the `code_excerpt_updater` command.
 
 File-scope global replace expressions are included at the top of some of site page markdown files.

package.json

@@ -0,0 +1,14 @@
+{
+  "name": "www.dartlang.org",
+  "version": "0.0.0",
+  "private": true,
+  "description": "www.dartlang.org",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dart-lang/site-www.git"
+  },
+  "devDependencies": {
+    "firebase-tools": "4.0.3",
+    "superstatic": "^5.0.2"
+  }
+}

site-shared

@@ -5,7 +5,7 @@
 # Don't exit on pipefail because we use `find`.
 # set -e -o pipefail
 
-[[ -z "$DART_SITE_ENV_DEFS" ]] && . ./scripts/env-set.sh
+[[ -z "$DART_SITE_ENV_DEFS" ]] && . ./tool/env-set.sh
 
 cd `dirname $0`/..
 ROOT=$(pwd)

scripts/analyze-and-test-examples.sh tool/analyze-and-test-examples.sh

@@ -2,12 +2,12 @@
 
 set -e -o pipefail
 
-[[ -z "$DART_SITE_ENV_DEFS" ]] && . ./scripts/env-set.sh
+[[ -z "$DART_SITE_ENV_DEFS" ]] && . ./tool/env-set.sh
 
 if [[ "$1" == --force ]]; then FORCE=1; fi
 
 if [[ -n "$TRAVIS" ]]; then
-  ./scripts/env-info-and-check.sh
+  ./tool/env-info-and-check.sh
   # travis_fold start before_install.update_apt_get
   #   (set -x; sudo apt-get update --yes)
   # travis_fold end before_install.update_apt_get
@@ -22,15 +22,7 @@ travis_fold start before_install.ruby_bundler
   fi
 travis_fold end before_install.ruby_bundler
 
-./scripts/install-dart-sdk.sh
-
-travis_fold start before_install.npm_install
-  if [[ -n "$TRAVIS" || -n "$FORCE" || -z "$(type -t firebase)" || -z "$(type -t gulp)" || -z "$(type -t superstatic)" ]]; then
-    (set -x; npm install --global firebase-tools@4.0.3 gulp-cli superstatic@5.0.2 --no-optional)
-  else
-    echo "Global NPM packages already installed. Use --force to reinstall/update."
-  fi
-travis_fold end before_install.npm_install
+./tool/install-dart-sdk.sh
 
 travis_fold start before_install.pub
   pub upgrade

scripts/before-install.sh tool/before-install.sh

@@ -4,17 +4,17 @@ set -e -o pipefail
 
 readonly rootDir="$(cd "$(dirname "$0")/.." && pwd)"
 
-[[ -z "$DART_SITE_ENV_DEFS" ]] && . $rootDir/scripts/env-set.sh
+[[ -z "$DART_SITE_ENV_DEFS" ]] && . $rootDir/tool/env-set.sh
 
 travis_fold start dartfmt
-(set -x; $rootDir/scripts/dartfmt.sh)
+(set -x; $rootDir/tool/dartfmt.sh)
 travis_fold end dartfmt
 
 errorMessage="
 Error: some code excerpts need to be refreshed.
-Rerun '$rootDir/scripts/refresh-code-excerpts.sh' locally.
+Rerun '$rootDir/tool/refresh-code-excerpts.sh' locally.
 "
 
 travis_fold start refresh_code_excerpts
-(set -x; $rootDir/scripts/refresh-code-excerpts.sh) || (printf "$errorMessage" && exit 1)
+(set -x; $rootDir/tool/refresh-code-excerpts.sh) || (printf "$errorMessage" && exit 1)
 travis_fold end refresh_code_excerpts

scripts/check-code.sh tool/check-code.sh

@@ -2,7 +2,7 @@
 
 set -e -o pipefail
 
-[[ -z "$DART_SITE_ENV_DEFS" ]] && . ./scripts/env-set.sh
+[[ -z "$DART_SITE_ENV_DEFS" ]] && . ./tool/env-set.sh
 
 travis_fold start env_info
   echo ENVIRONMENT INFO

scripts/config/linkcheck-skip-list.txt tool/config/linkcheck-skip-list.txt

@@ -1,5 +1,5 @@
 # This bash file is meant to be source'd, not executed.
 
-source scripts/shared/env-set.sh
+source tool/shared/env-set.sh
 
 # site-www specific settings here: currently, none.

scripts/convert_book.dart tool/convert_book.dart

@@ -2,15 +2,13 @@
 
 set -e -o pipefail
 
-[[ -z "$DART_SITE_ENV_DEFS" ]] && . ./scripts/env-set.sh
+[[ -z "$DART_SITE_ENV_DEFS" ]] && . ./tool/env-set.sh
 
 if  [[ -z "$(type -t dart)" ]]; then
     travis_fold start install.dart
-    echo INSTALLING Dart SDK and Dartium ...
+    echo INSTALLING Dart SDK ...
 
-    # URLs for sdk and dartium:
     # https://storage.googleapis.com/dart-archive/channels/stable/release/latest/sdk/dartsdk-linux-x64-release.zip
-    # https://storage.googleapis.com/dart-archive/channels/stable/release/latest/dartium/dartium-macos-x64-release.zip
 
     : ${DART_CHANNEL:=$(node -p 'require("./src/_data/pkg-vers.json").SDK.channel')} # dev or stable
 
@@ -46,7 +44,7 @@ if  [[ -z "$(type -t dart)" ]]; then
         if [[ "1000" -lt "$(wc -c $TMP/$zip | awk '{print $1}')" ]]; then
             unzip "$TMP/$zip" -d "$PKG" > /dev/null
             rm -f "$TMP/$zip"
-            # PATH is set in ./scripts/env-set.sh
+            # PATH is set in ./tool/env-set.sh
         else
             echo FAILED to download Dart $pkg. Check URL.
             exitStatus=1;
@@ -61,6 +59,6 @@ if  [[ -z "$(type -t dart)" ]]; then
     travis_fold end install.dart
 else
     echo Dart SDK appears to be installed: `type dart`
-    # PATH is set in ./scripts/env-set.sh
+    # PATH is set in ./tool/env-set.sh
     dart --version
 fi

scripts/create_site_main_example.dart tool/create_site_main_example.dart

@@ -13,6 +13,14 @@ else
     echo "Node version: $(node --version)"
 fi
 
-travis_fold start install.bundle
-(set -x; bundle install)
-travis_fold end install.bundle
+travis_fold start install.npm_install
+  (set -x; npm install --no-optional)
+travis_fold end install.npm_install
+
+if [[ "$CI_TASK" == build* ]]; then
+  travis_fold start install.bundle
+    (set -x; bundle install)
+  travis_fold end install.bundle
+fi
+
+echo "Installation done"

scripts/dartfmt.sh tool/dartfmt.sh

@@ -12,9 +12,9 @@ fi
 STATUS=0
 set -x
 
-./scripts/dartfmt.sh | grep -v Unchanged && \
-./scripts/refresh-code-excerpts.sh && \
-./scripts/analyze-and-test-examples.sh $* && \
+./tool/dartfmt.sh | grep -v Unchanged && \
+./tool/refresh-code-excerpts.sh && \
+./tool/analyze-and-test-examples.sh $* && \
 pushd deploy/effective-dart-rules && pub get && \
 popd && \
 dart deploy/effective-dart-rules/bin/main.dart

scripts/env-info-and-check.sh tool/env-info-and-check.sh

@@ -13,7 +13,7 @@ function usage() {
 
 if [[ $1 == '-h' || $1 == '--help' ]]; then usage; fi
 
-[[ -z "$DART_SITE_ENV_DEFS" ]] && . $rootDir/scripts/env-set.sh
+[[ -z "$DART_SITE_ENV_DEFS" ]] && . $rootDir/tool/env-set.sh
 [[ -z "$DART_SITE_ENV_DEFS" ]] && exit 1; # env-set failed, abort.
 
 ARGS=''
@@ -23,7 +23,7 @@ if [[ -e "$FRAG" ]]; then echo Deleting old "$FRAG"; rm -Rf "$FRAG"; fi
 
 if [[ $1 == '--legacy' ]]; then
   shift
-  $(npm bin)/code-excerpter examples "$FRAG"
+  npx code-excerpter examples "$FRAG"
 else
   ARGS+='--yaml '
   if [[ ! -e "pubspec.lock" ]]; then pub get; fi