Emit types (#442)

* build declaration files for app-utils * app-utils tsconfig: only look at source files * make kit types available where they need to be * changeset Co-authored-by: GrygrFlzr <[email protected]>
sveltejs · Mar 4, 2021 · b800049 · b800049
1 parent 4c6a4e7
commit b800049
Show file tree

Hide file tree

Showing 18 changed files with 80 additions and 63 deletions.
diff --git a/.changeset/modern-moose-greet.md b/.changeset/modern-moose-greet.md
@@ -0,0 +1,7 @@
+---
+'@sveltejs/app-utils': patch
+'create-svelte': patch
+'@sveltejs/kit': patch
+---
+
+Include type declarations
diff --git a/packages/app-utils/package.json b/packages/app-utils/package.json
@@ -3,9 +3,11 @@
 	"version": "1.0.0-next.1",
 	"scripts": {
 		"lint": "eslint --ignore-path .gitignore \"**/*.{ts,js,svelte}\" && npm run check-format",
+		"build": "tsc",
 		"format": "prettier --write . --config ../../.prettierrc --ignore-path .gitignore",
 		"check-format": "prettier --check . --config ../../.prettierrc --ignore-path .gitignore",
-		"test": "uvu"
+		"test": "uvu",
+		"prepublishOnly": "npm run build"
 	},
 	"devDependencies": {
 		"@types/node": "^14.14.22",

diff --git a/packages/app-utils/tsconfig.json b/packages/app-utils/tsconfig.json
@@ -6,7 +6,8 @@
 		"emitDeclarationOnly": true,
 		"noImplicitAny": true,
 		"target": "es2020",
-		"allowSyntheticDefaultImports": true
+		"allowSyntheticDefaultImports": true,
+		"moduleResolution": "node"
 	},
-	"include": ["./files", "./http"]
+	"include": ["./files/**.js", "./http/**.js"]
 }
diff --git a/packages/create-svelte/template/svelte.config.cjs b/packages/create-svelte/template/svelte.config.cjs
@@ -1,3 +1,4 @@
+/** @type {import('@sveltejs/kit').Config} */
 module.exports = {
 	kit: {
 		// By default, `npm run build` will create a standard Node app.

diff --git a/packages/create-svelte/template/tsconfig.json b/packages/create-svelte/template/tsconfig.json
@@ -0,0 +1,14 @@
+{
+	"compilerOptions": {
+		"allowJs": true,
+		"paths": {
+			"$app/*": [".svelte/dev/runtime/app/*", ".svelte/build/runtime/app/*"],
+			"$components/*": ["src/components/*"]
+		}
+	},
+	"include": [
+		"src/**/*.js",
+		"src/**/*.ts",
+		"src/**/*.svelte"
+	]
+}
diff --git a/packages/create-svelte/template/vite.config.js b/packages/create-svelte/template/vite.config.js
@@ -1,6 +1,7 @@
 // Consult https://vitejs.dev/config/ to learn about these options
 import { resolve } from 'path';
 
+/** @type {import('vite').UserConfig} */
 export default {
 	resolve: {
 		alias: {

diff --git a/packages/kit/package.json b/packages/kit/package.json
@@ -60,5 +60,6 @@
 		"./renderer": {
 			"import": "./dist/renderer.js"
 		}
-	}
+	},
+	"types": "types.d.ts"
 }
diff --git a/packages/kit/rollup.config.js b/packages/kit/rollup.config.js
@@ -16,9 +16,10 @@ export default [
 		input: {
 			'internal/start': 'src/runtime/internal/start.js',
 			'internal/singletons': 'src/runtime/internal/singletons.js',
-			'app/navigation': 'src/runtime/app/navigation/index.js',
-			'app/stores': 'src/runtime/app/stores/index.js',
-			'app/paths': 'src/runtime/app/paths/index.js'
+			'app/navigation': 'src/runtime/app/navigation.js',
+			'app/stores': 'src/runtime/app/stores.js',
+			'app/paths': 'src/runtime/app/paths.js',
+			'app/env': 'src/runtime/app/env.js'
 		},
 		output: {
 			dir: 'assets/runtime',
@@ -54,7 +55,10 @@ export default [
 		},
 		plugins: [
 			replace({
-				__VERSION__: pkg.version
+				preventAssignment: true,
+				values: {
+					__VERSION__: pkg.version
+				}
 			}),
 			resolve({
 				extensions: ['.mjs', '.js', '.ts']

diff --git a/packages/kit/src/api/build/index.js b/packages/kit/src/api/build/index.js
@@ -31,12 +31,7 @@ export async function build(config, { cwd }) {
 
 	copy_assets(build_dir);
 
-	// prettier-ignore
-	writeFileSync(`${build_dir}/runtime/app/env.js`, [
-		'export const browser = !import.meta.env.SSR;',
-		'export const dev = false;',
-		`export const amp = ${config.kit.amp};`
-	].join('\n'));
+	process.env.VITE_AMP = config.kit.amp ? 'true' : '';
 
 	const client_entry_file = `${build_dir}/runtime/internal/start.js`;
 	const client_out_dir = `${cwd}/client/${config.kit.appDir}`;

diff --git a/packages/kit/src/api/dev/index.js b/packages/kit/src/api/dev/index.js
@@ -40,16 +40,8 @@ class Watcher extends EventEmitter {
 
 	async init() {
 		rimraf(dev_dir);
-
 		copy_assets(dev_dir);
-
-		// TODO move this (and copy_assets?) into create_app
-		// prettier-ignore
-		writeFileSync(`${dev_dir}/runtime/app/env.js`, [
-			'export const browser = !import.meta.env.SSR;',
-			'export const dev = true;',
-			`export const amp = ${this.config.kit.amp};`
-		].join('\n'));
+		process.env.VITE_AMP = this.config.kit.amp ? 'true' : '';
 
 		await this.init_filewatcher();
 		await this.init_server();

diff --git a/packages/kit/src/runtime/app/env.js b/packages/kit/src/runtime/app/env.js
@@ -0,0 +1,3 @@
+export const browser = !import.meta.env.SSR;
+export const dev = !!import.meta.env.DEV;
+export const amp = !!import.meta.env.VITE_AMP;
diff --git a/...s/kit/src/runtime/app/navigation/index.js → packages/kit/src/runtime/app/navigation.js b/...s/kit/src/runtime/app/navigation/index.js → packages/kit/src/runtime/app/navigation.js
@@ -1,5 +1,5 @@
-import { router, renderer } from '../../internal/singletons';
-import { get_base_uri } from '../../internal/utils';
+import { router, renderer } from '../internal/singletons';
+import { get_base_uri } from '../internal/utils';
 
 /**
  * @param {string} href

diff --git a/packages/kit/src/runtime/app/paths.js b/packages/kit/src/runtime/app/paths.js
@@ -0,0 +1 @@
+export { base, assets } from '../internal/singletons';
diff --git a/packages/kit/src/runtime/app/paths/index.js b/packages/kit/src/runtime/app/paths/index.js
diff --git a/packages/kit/src/runtime/app/stores/index.js → packages/kit/src/runtime/app/stores.js b/packages/kit/src/runtime/app/stores/index.js → packages/kit/src/runtime/app/stores.js
diff --git a/packages/kit/src/runtime/internal/singletons.js b/packages/kit/src/runtime/internal/singletons.js
@@ -1,7 +1,7 @@
-/** @type {import('./router').Router} */
+/** @type {any} */
 export let router;
 
-/** @type {import('./renderer').Renderer} */
+/** @type {any} */
 export let renderer;
 
 /** @type {string} */
@@ -10,10 +10,7 @@ export let base;
 /** @type {string} */
 export let assets;
 
-/** @param {{
- *   router: import('./router').Router,
- *   renderer: import('./renderer').Renderer
- * }} opts */
+/** @param {any} opts */
 export function init(opts) {
 	({ router, renderer } = opts);
 }

diff --git a/packages/kit/src/types.d.ts b/packages/kit/src/types.d.ts
@@ -7,37 +7,6 @@ export type Logger = {
 	info: (msg: string) => void;
 };
 
-export type Config = {
-	compilerOptions?: any;
-	extensions?: string[];
-	kit?: {
-		adapter?: string | [string, any];
-		amp?: boolean;
-		appDir?: string;
-		files?: {
-			assets?: string;
-			routes?: string;
-			setup?: string;
-			template?: string;
-		};
-		host?: string;
-		hostHeader?: string;
-		paths?: {
-			base?: string;
-			assets?: string;
-		};
-		prerender?: {
-			crawl?: boolean;
-			enabled?: boolean;
-			force?: boolean;
-			pages?: string[];
-		};
-		startGlobal?: string;
-		target?: string;
-	};
-	preprocess?: any;
-};
-
 export type ValidatedConfig = {
 	compilerOptions: any;
 	extensions: string[];

diff --git a/packages/kit/types.d.ts b/packages/kit/types.d.ts
@@ -0,0 +1,30 @@
+export type Config = {
+	compilerOptions?: any;
+	extensions?: string[];
+	kit?: {
+		adapter?: string | [string, any];
+		amp?: boolean;
+		appDir?: string;
+		files?: {
+			assets?: string;
+			routes?: string;
+			setup?: string;
+			template?: string;
+		};
+		host?: string;
+		hostHeader?: string;
+		paths?: {
+			base?: string;
+			assets?: string;
+		};
+		prerender?: {
+			crawl?: boolean;
+			enabled?: boolean;
+			force?: boolean;
+			pages?: string[];
+		};
+		startGlobal?: string;
+		target?: string;
+	};
+	preprocess?: any;
+};
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export { base, assets } from '../internal/singletons';