Add a shape to the TS config files (#1466)

* Add a shape to the TS config files * Use the jsdoc comment for typing the snowpack config everywhere * Fix tests
FredKSchott · Nov 2, 2020 · d647138 · d647138 · vercel · Nov 2, 2020
1 parent c438b29
commit d647138
Show file tree

Hide file tree

Showing 15 changed files with 16 additions and 1 deletion.
diff --git a/create-snowpack-app/app-template-11ty/snowpack.config.js b/create-snowpack-app/app-template-11ty/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     _output: '/',

diff --git a/create-snowpack-app/app-template-blank-typescript/snowpack.config.js b/create-snowpack-app/app-template-blank-typescript/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     public: '/',

diff --git a/create-snowpack-app/app-template-blank/snowpack.config.js b/create-snowpack-app/app-template-blank/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     public: '/',

diff --git a/create-snowpack-app/app-template-lit-element-typescript/snowpack.config.js b/create-snowpack-app/app-template-lit-element-typescript/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     public: '/',

diff --git a/create-snowpack-app/app-template-lit-element/snowpack.config.js b/create-snowpack-app/app-template-lit-element/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     public: '/',

diff --git a/create-snowpack-app/app-template-minimal/snowpack.config.js b/create-snowpack-app/app-template-minimal/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     /* ... */

diff --git a/create-snowpack-app/app-template-preact-typescript/snowpack.config.js b/create-snowpack-app/app-template-preact-typescript/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     public: '/',

diff --git a/create-snowpack-app/app-template-preact/snowpack.config.js b/create-snowpack-app/app-template-preact/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     public: '/',

diff --git a/create-snowpack-app/app-template-react-typescript/snowpack.config.js b/create-snowpack-app/app-template-react-typescript/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     public: '/',

diff --git a/create-snowpack-app/app-template-react/snowpack.config.js b/create-snowpack-app/app-template-react/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     public: '/',

diff --git a/create-snowpack-app/app-template-svelte-typescript/snowpack.config.js b/create-snowpack-app/app-template-svelte-typescript/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     public: '/',

diff --git a/create-snowpack-app/app-template-svelte/snowpack.config.js b/create-snowpack-app/app-template-svelte/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     public: '/',

diff --git a/create-snowpack-app/app-template-vue-typescript/snowpack.config.js b/create-snowpack-app/app-template-vue-typescript/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     public: '/',

diff --git a/create-snowpack-app/app-template-vue/snowpack.config.js b/create-snowpack-app/app-template-vue/snowpack.config.js
@@ -1,3 +1,4 @@
+/** @type {import("snowpack").SnowpackUserConfig } */
 module.exports = {
   mount: {
     public: '/',

diff --git a/test/create-snowpack-app/__snapshots__/create-snowpack-app.test.js.snap b/test/create-snowpack-app/__snapshots__/create-snowpack-app.test.js.snap
@@ -7384,7 +7384,8 @@ exports[`create-snowpack-app app-template-minimal > build: package.json 1`] = `
 `;
 
 exports[`create-snowpack-app app-template-minimal > build: snowpack.config.js 1`] = `
-"module.exports = {
+"/** @type {import(\\"snowpack\\").SnowpackUserConfig } */
+module.exports = {
   mount: {
   },
   plugins: [