From 7c6ec7413335dae6bedc2bd01c29ea546524b655 Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Sat, 4 Aug 2018 17:19:08 -0400 Subject: [PATCH] tweak readme, use npm ci --- .travis.yml | 2 +- README.md | 8 +++---- appveyor.yml | 2 +- package-lock.json | 55 ++++++++++++++++------------------------------- 4 files changed, 25 insertions(+), 42 deletions(-) diff --git a/.travis.yml b/.travis.yml index 5aba7e8a73..3cc20455e8 100644 --- a/.travis.yml +++ b/.travis.yml @@ -15,6 +15,6 @@ addons: install: - export DISPLAY=':99.0' - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 & - - npm install + - npm ci || install after_success: npm run codecov diff --git a/README.md b/README.md index 857e1d233e..3df1543130 100644 --- a/README.md +++ b/README.md @@ -132,15 +132,13 @@ The `style` and `script` preprocessors will run *after* the `markup` preprocesso ## Example/starter repos +* [sveltejs/template](https://github.com/sveltejs/template) — the 'official' starter template +* [sveltejs/template-webpack](https://github.com/sveltejs/template-webpack) — using webpack for bundling * [charpeni/svelte-example](https://github.com/charpeni/svelte-example) - Some Svelte examples with configured Rollup, Babel, ESLint, directives, Two-Way binding, and nested components * [EmilTholin/svelte-test](https://github.com/EmilTholin/svelte-test) * [lukechinworth/codenames](https://github.com/lukechinworth/codenames/tree/svelte) – example integration with Redux * [khtdr/svelte-redux-shopping-cart](https://github.com/khtdr/svelte-redux-shopping-cart) – Redux Shopping Cart example (with devtools and hot-reloading) -## BrowserStack - -

To keep Svelte's performance in check, we use BrowserStack to quickly run benchmarks for each PR that immediately give feedback to the contributor. You can see how we use BrowserStack in the svelte-bench project and check out BrowserStack's services on their website.

- ## Development Pull requests are encouraged and always welcome. [Pick an issue](https://github.com/sveltejs/svelte/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and help us out! @@ -154,6 +152,8 @@ npm install npm run dev ``` +The compiler is written in [TypeScript](https://www.typescriptlang.org/), but don't let that put you off — it's basically just JavaScript with type annotations. You'll pick it up in no time. If you're using an editor other than [VSCode](https://code.visualstudio.com/) you may need to install a plugin in order to get syntax highlighting and code hints etc. + ### Linking to a Live Project You can make changes locally to Svelte and test it against any Svelte project. You can also use a [default template](https://github.com/sveltejs/template) for development. Instruction on setup are found in that project repository. diff --git a/appveyor.yml b/appveyor.yml index 19dcad4f15..71b7cec808 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -14,7 +14,7 @@ environment: install: - ps: Install-Product node $env:nodejs_version - - npm install + - npm ci build: off diff --git a/package-lock.json b/package-lock.json index 679617de2f..2487d39c26 100644 --- a/package-lock.json +++ b/package-lock.json @@ -140,9 +140,9 @@ "dev": true }, "@types/node": { - "version": "10.5.5", - "resolved": "https://registry.npmjs.org/@types/node/-/node-10.5.5.tgz", - "integrity": "sha512-6Qnb1gXbp3g1JX9QVJj3A6ORzc9XCyhokxUKaoonHgNXcQhmk8adhotxfkeK8El9TnFeUuH72yI6jQ5nDJKS6w==", + "version": "10.5.6", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.5.6.tgz", + "integrity": "sha512-c5Z1j1ysgo4878ptz6gxLcgMfJ6Wf908R3l5KAGabr0XJ72ZFmOCgsaodPpNYTfp4iOrSwgTDvR/BxbFfB4zPQ==", "dev": true }, "abab": { @@ -465,15 +465,6 @@ "vlq": "1.0.0" }, "dependencies": { - "acorn-jsx": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-4.1.1.tgz", - "integrity": "sha512-JY+iV6r+cO21KtntVvFkD+iqjtdpRUpGqKWgfkCdZq1R+kbreEl8EcdcJR4SmiIgsIQT33s6QzheQ9a275Q8xw==", - "dev": true, - "requires": { - "acorn": "5.7.1" - } - }, "magic-string": { "version": "0.22.5", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.22.5.tgz", @@ -849,14 +840,6 @@ "requires": { "foreach": "2.0.5", "object-keys": "1.0.12" - }, - "dependencies": { - "object-keys": { - "version": "1.0.12", - "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.0.12.tgz", - "integrity": "sha512-FTMyFUm2wBcGHnH2eXmz7tC6IwlqQZ6mVZ+6dm6vZ4IQIHjs6FdNsQBuKGPuUUUY6NfJw2PshC08Tn6LzLDOag==", - "dev": true - } } }, "del": { @@ -881,9 +864,9 @@ "dev": true }, "diff": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/diff/-/diff-3.2.0.tgz", - "integrity": "sha1-yc45Okt8vQsFinJck98pkCeGj/k=", + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-3.5.0.tgz", + "integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==", "dev": true }, "doctrine": { @@ -3065,14 +3048,6 @@ "minimatch": "3.0.4", "mkdirp": "0.5.1", "supports-color": "5.4.0" - }, - "dependencies": { - "diff": { - "version": "3.5.0", - "resolved": "https://registry.npmjs.org/diff/-/diff-3.5.0.tgz", - "integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==", - "dev": true - } } }, "mri": { @@ -5295,9 +5270,9 @@ "dev": true }, "object-keys": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-0.4.0.tgz", - "integrity": "sha1-KKaq50KN0sOpLz2V8hM13SBOAzY=", + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.0.12.tgz", + "integrity": "sha512-FTMyFUm2wBcGHnH2eXmz7tC6IwlqQZ6mVZ+6dm6vZ4IQIHjs6FdNsQBuKGPuUUUY6NfJw2PshC08Tn6LzLDOag==", "dev": true }, "object.omit": { @@ -5851,7 +5826,7 @@ "dev": true, "requires": { "@types/estree": "0.0.39", - "@types/node": "10.5.5" + "@types/node": "10.5.6" }, "dependencies": { "@types/estree": { @@ -6576,7 +6551,7 @@ "requires": { "arrify": "1.0.1", "buffer-from": "1.1.1", - "diff": "3.2.0", + "diff": "3.5.0", "make-error": "1.3.4", "minimist": "1.2.0", "mkdirp": "0.5.1", @@ -6798,6 +6773,14 @@ "dev": true, "requires": { "object-keys": "0.4.0" + }, + "dependencies": { + "object-keys": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-0.4.0.tgz", + "integrity": "sha1-KKaq50KN0sOpLz2V8hM13SBOAzY=", + "dev": true + } } }, "yauzl": {