Templates: Adding descriptions to package.json, making config files c…

…onsistant (#1346)

* adding descriptions, making config files consistant

* reordering keys in templates, adding comment about 11ty

create-snowpack-app/app-template-11ty/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@snowpack/app-template-11ty",
+  "description": "A preconfigured template for Snowpack with Eleventy",
   "version": "1.9.3",
   "license": "MIT",
   "homepage": "https://github.com/pikapkg/snowpack/tree/master/create-snowpack-app/app-template-11ty#readme",

create-snowpack-app/app-template-11ty/snowpack.config.js

@@ -0,0 +1,28 @@
+module.exports = {
+  mount: {
+    _output: '/',
+    src: '/_dist_',
+  },
+  plugins: [
+    ['@snowpack/plugin-run-script', { cmd: 'eleventy', watch: '$1 --watch' }],
+  ],
+  install: [
+    /* ... */
+  ],
+  installOptions: {
+    /* ... */
+  },
+  devOptions: {
+    // Eleventy updates multiple files at once, so add a 300ms delay before we trigger a browser update
+    hmrDelay: 300,
+  },
+  buildOptions: {
+    /* ... */
+  },
+  proxy: {
+    /* ... */
+  },
+  alias: {
+    /* ... */
+  },
+};

create-snowpack-app/app-template-blank-typescript/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@snowpack/app-template-blank-typescript",
+  "description": "A preconfigured template for Snowpack with Typescript",
   "version": "1.9.7",
   "license": "MIT",
   "homepage": "https://github.com/pikapkg/snowpack/tree/master/create-snowpack-app/app-template-blank-typescript#readme",

create-snowpack-app/app-template-blank-typescript/snowpack.config.js

@@ -0,0 +1,25 @@
+module.exports = {
+  mount: {
+    public: '/',
+    src: '/_dist_',
+  },
+  plugins: ['@snowpack/plugin-typescript'],
+  install: [
+    /* ... */
+  ],
+  installOptions: {
+    installTypes: true,
+  },
+  devOptions: {
+    /* ... */
+  },
+  buildOptions: {
+    /* ... */
+  },
+  proxy: {
+    /* ... */
+  },
+  alias: {
+    /* ... */
+  },
+};

create-snowpack-app/app-template-blank/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@snowpack/app-template-blank",
+  "description": "A preconfigured template for Snowpack with Prettier",
   "version": "1.6.19",
   "license": "MIT",
   "homepage": "https://github.com/pikapkg/snowpack/tree/master/create-snowpack-app/app-template-blank#readme",

create-snowpack-app/app-template-blank/snowpack.config.js

@@ -0,0 +1,27 @@
+module.exports = {
+  mount: {
+    public: '/',
+    src: '/_dist_',
+  },
+  plugins: [
+    /* ... */
+  ],
+  install: [
+    /* ... */
+  ],
+  installOptions: {
+    /* ... */
+  },
+  devOptions: {
+    /* ... */
+  },
+  buildOptions: {
+    /* ... */
+  },
+  proxy: {
+    /* ... */
+  },
+  alias: {
+    /* ... */
+  },
+};

create-snowpack-app/app-template-lit-element-typescript/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@snowpack/app-template-lit-element-typescript",
+  "description": "A preconfigured template for Snowpack with TypeScript and LitElement",
   "version": "1.10.6",
   "license": "MIT",
   "homepage": "https://github.com/pikapkg/snowpack/tree/master/create-snowpack-app/app-template-lit-element-typescript#readme",

create-snowpack-app/app-template-lit-element-typescript/snowpack.config.js

@@ -6,6 +6,24 @@ module.exports = {
   plugins: [
     '@snowpack/plugin-babel',
     '@snowpack/plugin-dotenv',
-    "@snowpack/plugin-typescript"
+    '@snowpack/plugin-typescript',
   ],
+  install: [
+    /* ... */
+  ],
+  installOptions: {
+    /* ... */
+  },
+  devOptions: {
+    /* ... */
+  },
+  buildOptions: {
+    /* ... */
+  },
+  proxy: {
+    /* ... */
+  },
+  alias: {
+    /* ... */
+  },
 };

create-snowpack-app/app-template-lit-element/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@snowpack/app-template-lit-element",
+  "description": "A preconfigured template for Snowpack with LitElement",
   "version": "1.9.6",
   "license": "MIT",
   "homepage": "https://github.com/pikapkg/snowpack/tree/master/create-snowpack-app/app-template-lit-element#readme",

create-snowpack-app/app-template-lit-element/snowpack.config.js

@@ -4,4 +4,22 @@ module.exports = {
     src: '/_dist_',
   },
   plugins: ['@snowpack/plugin-babel', '@snowpack/plugin-dotenv'],
+  install: [
+    /* ... */
+  ],
+  installOptions: {
+    /* ... */
+  },
+  devOptions: {
+    /* ... */
+  },
+  buildOptions: {
+    /* ... */
+  },
+  proxy: {
+    /* ... */
+  },
+  alias: {
+    /* ... */
+  },
 };

create-snowpack-app/app-template-minimal/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@snowpack/app-template-minimal",
+  "description": "A preconfigured minimal template for Snowpack",
   "private": true,
   "version": "1.6.12",
   "license": "MIT",

create-snowpack-app/app-template-minimal/snowpack.config.js

@@ -1,10 +1,13 @@
 module.exports = {
-  install: [
+  mount: {
     /* ... */
-  ],
+  },
   plugins: [
     /* ... */
   ],
+  install: [
+    /* ... */
+  ],
   installOptions: {
     /* ... */
   },
@@ -17,9 +20,6 @@ module.exports = {
   proxy: {
     /* ... */
   },
-  mount: {
-    /* ... */
-  },
   alias: {
     /* ... */
   },

create-snowpack-app/app-template-preact-typescript/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@snowpack/app-template-preact-typescript",
+  "description": "A preconfigured template for Snowpack with Preact and Typescript",
   "version": "1.1.3",
   "license": "MIT",
   "homepage": "https://github.com/pikapkg/snowpack/tree/master/create-snowpack-app/app-template-preact-typescript#readme",

create-snowpack-app/app-template-preact-typescript/snowpack.config.js

@@ -7,9 +7,24 @@ module.exports = {
     '@snowpack/plugin-dotenv',
     '@snowpack/plugin-babel',
     '@snowpack/plugin-typescript',
-    '@prefresh/snowpack'
+    '@prefresh/snowpack',
+  ],
+  install: [
+    /* ... */
   ],
   installOptions: {
     installTypes: true,
   },
+  devOptions: {
+    /* ... */
+  },
+  buildOptions: {
+    /* ... */
+  },
+  proxy: {
+    /* ... */
+  },
+  alias: {
+    /* ... */
+  },
 };

create-snowpack-app/app-template-preact/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@snowpack/app-template-preact",
+  "description": "A preconfigured template for Snowpack with Preact",
   "version": "1.11.3",
   "license": "MIT",
   "homepage": "https://github.com/pikapkg/snowpack/tree/master/create-snowpack-app/app-template-preact#readme",

create-snowpack-app/app-template-preact/snowpack.config.js

@@ -3,8 +3,24 @@ module.exports = {
     public: '/',
     src: '/_dist_',
   },
-  plugins: [
-    '@snowpack/plugin-dotenv',
-    '@prefresh/snowpack',
+  plugins: ['@snowpack/plugin-dotenv', '@prefresh/snowpack'],
+  install: [
+    /* ... */
   ],
+  installOptions: {
+    /* ... */
+  },
+  devOptions: {
+    /* ... */
+  },
+  buildOptions: {
+    /* ... */
+  },
+  proxy: {
+    /* ... */
+  },
+
+  alias: {
+    /* ... */
+  },
 };

create-snowpack-app/app-template-react-typescript/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@snowpack/app-template-react-typescript",
+  "description": "A preconfigured template for Snowpack with React and TypeScript",
   "version": "1.14.2",
   "license": "MIT",
   "homepage": "https://github.com/pikapkg/snowpack/tree/master/create-snowpack-app/app-template-react-typescript#readme",

create-snowpack-app/app-template-react-typescript/snowpack.config.js

@@ -6,6 +6,24 @@ module.exports = {
   plugins: [
     '@snowpack/plugin-react-refresh',
     '@snowpack/plugin-dotenv',
-    "@snowpack/plugin-typescript"
+    '@snowpack/plugin-typescript',
   ],
+  install: [
+    /* ... */
+  ],
+  installOptions: {
+    /* ... */
+  },
+  devOptions: {
+    /* ... */
+  },
+  buildOptions: {
+    /* ... */
+  },
+  proxy: {
+    /* ... */
+  },
+  alias: {
+    /* ... */
+  },
 };

create-snowpack-app/app-template-react/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@snowpack/app-template-react",
+  "description": "A preconfigured template for Snowpack with React",
   "version": "1.12.2",
   "license": "MIT",
   "homepage": "https://github.com/pikapkg/snowpack/tree/master/create-snowpack-app/app-template-react#readme",

create-snowpack-app/app-template-react/snowpack.config.js

@@ -4,4 +4,22 @@ module.exports = {
     src: '/_dist_',
   },
   plugins: ['@snowpack/plugin-react-refresh', '@snowpack/plugin-dotenv'],
+  install: [
+    /* ... */
+  ],
+  installOptions: {
+    /* ... */
+  },
+  devOptions: {
+    /* ... */
+  },
+  buildOptions: {
+    /* ... */
+  },
+  proxy: {
+    /* ... */
+  },
+  alias: {
+    /* ... */
+  },
 };

create-snowpack-app/app-template-svelte-typescript/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@snowpack/app-template-svelte-typescript",
+  "description": "A preconfigured template for Snowpack with Svelte and TypeScript",
   "version": "1.11.3",
   "license": "MIT",
   "homepage": "https://github.com/pikapkg/snowpack/tree/master/create-snowpack-app/app-template-svelte-typescript#readme",