@ryanatkn/gro 0.113.1 → 0.114.0

package/dist/docs/README.gen.md.js

@@ -22,13 +22,13 @@ export const gen = async ({ origin_id }) => {
     const output_file_name = to_output_file_name(origin_base);
     // TODO this is GitHub-specific
     const root_link = `[${root_path}](/../..)`;
-    const docFiles = await search_fs(origin_dir);
-    const docPaths = [];
-    for (const path of docFiles.keys()) {
+    const doc_files = await search_fs(origin_dir);
+    const doc_paths = [];
+    for (const path of doc_files.keys()) {
         if (path === output_file_name || !path.endsWith('.md')) {
             continue;
         }
-        docPaths.push(path);
+        doc_paths.push(path);
     }
     // TODO do we want to use absolute paths instead of relative paths,
     // because GitHub works with them and it simplifies the code?
@@ -45,7 +45,7 @@ export const gen = async ({ origin_id }) => {
 
 ${breadcrumbs}
 
-${docPaths.reduce((docList, doc) => docList + `- [${basename(doc, '.md')}](${doc})\n`, '')}
+${doc_paths.reduce((docList, doc) => docList + `- [${basename(doc, '.md')}](${doc})\n`, '')}
 ${breadcrumbs}
 
 > <sub>generated by [${origin_base}](${origin_base})</sub>

package/dist/docs/README.md

@@ -7,7 +7,7 @@
 - [deploy](deploy.md)
 - [dev](dev.md)
 - [gen](gen.md)
-- [gro_plugin_sveltekit_frontend](gro_plugin_sveltekit_frontend.md)
+- [gro_plugin_sveltekit_app](gro_plugin_sveltekit_app.md)
 - [package_json](package_json.md)
 - [plugin](plugin.md)
 - [publish](publish.md)

package/dist/docs/{gro_plugin_sveltekit_frontend.md → gro_plugin_sveltekit_app.md}

@@ -15,7 +15,7 @@ const config: Gro_ConfigCreator = async (cfg) => {
 			// host_target?: Host_Target;
 			// well_known_package_json?: boolean | Map_Package_Json;
 			// well_known_src_json?: boolean | Map_Src_Json;
-			// filter_well_known_src?: (source: string, destination: string) => boolean | Promise<boolean>;
+			// well_known_src?: boolean | Copy_File_Filter;
 		}),
 	];
 	return cfg;
@@ -26,9 +26,19 @@ export default config;
 // src/lib/gro_plugin_sveltekit_app.ts
 export type Host_Target = 'github_pages' | 'static' | 'node';
 
+export interface Copy_File_Filter {
+	(file_path: string): boolean | Promise<boolean>;
+}
+
+// src/lib/package_json.ts
 export interface Map_Package_Json {
 	(package_json: Package_Json): Package_Json | null | Promise<Package_Json | null>;
 }
+
+// src/lib/src_json.ts
+export interface Map_Src_Json {
+	(src_json: Src_Json): Src_Json | null | Promise<Src_Json | null>;
+}
 ```
 
 ## `host_target`
@@ -92,6 +102,12 @@ The `.well-known/src.json` file contains more details about
 the `package.json`'s `exports`, like exported identifier names and types.
 It maps each export to a source file in `.well-known/src/`.
 
-The contents of your `src/` directory are copied to `.well-known/src/`
-using the same filter as `exports` in `package.json` by default,
-and this can be customized with `filter_well_known_src`.
+## `well_known_src`
+
+The contents of your `src/` directory can be included in the output
+if you want your app's source code to be available the same as the built files.
+This is disabled by default.
+If `well_known_src` is truthy,
+the plugin copies `src/` to `static/.well-known/src/` during `vite build`.
+Passing `true` uses the same filter as `exports` in `package.json` by default,
+and it also accepts a custom filter function.

package/dist/docs/package_json.md

@@ -12,18 +12,21 @@ behavior designed for public open source projects:
   copies `package.json` from your project root to your
   SvelteKit static directory at `.well-known/package.json` during `vite build`,
   mapping it with the optional
-  [`well_known_package_json` option](./gro_plugin_sveltekit_app.md#well_known_package_json)
+  [`well_known_package_json` option](./gro_plugin_sveltekit_app.md#well_known_package_json).
 - `gro_plugin_sveltekit_app` outputs `.well-known/src.json`
   using the `exports` property of `package.json` during `vite build`,
   containing additional information about the source modules,
   mapping it with the optional
-  [`well_known_src_json` option](./gro_plugin_sveltekit_app.md#well_known_src_json)
-- `gro_plugin_sveltekit_app` outputs `.well-known/src/` by
-  copying over `src/` filtered by `filter_well_known_src` during `vite build` -
-  this is costly (usually more than doubling the final output size
+  [`well_known_src_json` option](./gro_plugin_sveltekit_app.md#well_known_src_json).
+- If you opt in with `well_known_src`,
+  `gro_plugin_sveltekit_app` outputs `.well-known/src/` by
+  copying over `src/` during `vite build`, filtered by `well_known_src` if it's a function.
+  This is costly (usually more than doubling the final output size
   of the code files in bytes, not counting images and such),
-  and it slows the build because it copies your entire source tree (sorry to hard drives),
-  but the UX is not affected
+  it slows the build because it copies your entire source tree (sorry to hard drives),
+  and it exposes your source code the same as the built files.
 
-> ⚠️ Setting `"public": true` in `package.json` exposes your source code at your deployed endpoint!
-> If that's the public web, that means your source code is public.
+> ⚠️ Setting `"public": true` in `package.json` exposes your `package.json`
+> and `src.json` metadata with your other built files by default!
+> Further opting in with `well_known_src` exposes your actual source files.
+> If your built files are public, that means these additional files are also public.

package/dist/gro_plugin_sveltekit_app.d.ts

@@ -19,9 +19,13 @@ export interface Options {
      */
     well_known_src_json?: boolean | Map_Src_Json;
     /**
-     * Filter what's copied from `src/` to `.well-known/src/`.
+     * If truthy, copies `src/` to `/.well-known/src/` to the static output.
+     * Pass a function to customize which files get copied.
      */
-    filter_well_known_src?: (source: string, destination: string) => boolean | Promise<boolean>;
+    well_known_src?: boolean | Copy_File_Filter;
 }
 export type Host_Target = 'github_pages' | 'static' | 'node';
-export declare const gro_plugin_sveltekit_app: ({ host_target, well_known_package_json, well_known_src_json, filter_well_known_src, }?: Options) => Plugin<Plugin_Context>;
+export interface Copy_File_Filter {
+    (file_path: string): boolean | Promise<boolean>;
+}
+export declare const gro_plugin_sveltekit_app: ({ host_target, well_known_package_json, well_known_src_json, well_known_src, }?: Options) => Plugin<Plugin_Context>;

package/dist/gro_plugin_sveltekit_app.js

@@ -11,7 +11,7 @@ import { serialize_src_json, create_src_json } from './src_json.js';
 import { DEFAULT_EXPORTS_EXCLUDER } from './config.js';
 import { SVELTEKIT_CONFIG_FILENAME } from './paths.js';
 export const has_sveltekit_app = () => exists(SVELTEKIT_CONFIG_FILENAME);
-export const gro_plugin_sveltekit_app = ({ host_target = 'github_pages', well_known_package_json, well_known_src_json, filter_well_known_src = (source) => !DEFAULT_EXPORTS_EXCLUDER.test(source), } = {}) => {
+export const gro_plugin_sveltekit_app = ({ host_target = 'github_pages', well_known_package_json, well_known_src_json, well_known_src, } = {}) => {
     let sveltekit_process = null;
     return {
         name: 'gro_plugin_sveltekit_app',
@@ -65,8 +65,10 @@ export const gro_plugin_sveltekit_app = ({ host_target = 'github_pages', well_kn
                     serialized_src_json
                         ? await create_temporarily(join(assets_path, '.well-known/src.json'), serialized_src_json)
                         : null,
-                    serialized_src_json
-                        ? await copy_temporarily('src', assets_path, '.well-known', filter_well_known_src)
+                    serialized_src_json && well_known_src
+                        ? await copy_temporarily('src', assets_path, '.well-known', well_known_src === true
+                            ? (file_path) => !DEFAULT_EXPORTS_EXCLUDER.test(file_path)
+                            : well_known_src)
                         : null,
                     /**
                      * GitHub pages processes everything with Jekyll by default,

package/dist/package.d.ts

@@ -95,6 +95,7 @@ export declare const package_json: {
             default: string;
             types: string;
         };
+        './package.json': string;
         './args.js': {
             default: string;
             types: string;
@@ -416,6 +417,10 @@ export declare const src_json: {
                 kind: string;
             }[];
         };
+        './package.json': {
+            path: string;
+            declarations: never[];
+        };
         './args.js': {
             path: string;
             declarations: {

package/dist/package.js

@@ -1,7 +1,7 @@
 // generated by src/lib/package.gen.ts
 export const package_json = {
     name: '@ryanatkn/gro',
-    version: '0.113.1',
+    version: '0.114.0',
     description: 'task runner and toolkit extending SvelteKit',
     icon: '🌰',
     public: true,
@@ -78,6 +78,7 @@ export const package_json = {
     },
     exports: {
         '.': { default: './dist/index.js', types: './dist/index.d.ts' },
+        './package.json': './package.json',
         './args.js': { default: './dist/args.js', types: './dist/args.d.ts' },
         './build.task.js': { default: './dist/build.task.js', types: './dist/build.task.d.ts' },
         './changelog.js': { default: './dist/changelog.js', types: './dist/changelog.d.ts' },
@@ -234,7 +235,7 @@ export const package_json = {
 };
 export const src_json = {
     name: '@ryanatkn/gro',
-    version: '0.113.1',
+    version: '0.114.0',
     modules: {
         '.': {
             path: 'index.ts',
@@ -250,6 +251,7 @@ export const src_json = {
                 { name: 'Task_Error', kind: 'class' },
             ],
         },
+        './package.json': { path: 'package.json', declarations: [] },
         './args.js': {
             path: 'args.ts',
             declarations: [
@@ -525,6 +527,7 @@ export const src_json = {
                 { name: 'has_sveltekit_app', kind: 'function' },
                 { name: 'Options', kind: 'type' },
                 { name: 'Host_Target', kind: 'type' },
+                { name: 'Copy_File_Filter', kind: 'type' },
                 { name: 'gro_plugin_sveltekit_app', kind: 'function' },
             ],
         },

package/dist/package_json.d.ts

@@ -39,7 +39,7 @@ export declare const Package_Json_Funding: z.ZodUnion<[z.ZodString, z.ZodObject<
     url: z.ZodString;
 }, z.ZodTypeAny, "passthrough">>]>;
 export type Package_Json_Funding = z.infer<typeof Package_Json_Funding>;
-export declare const Package_Json_Exports: z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
+export declare const Package_Json_Exports: z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>>;
 export type Package_Json_Exports = z.infer<typeof Package_Json_Exports>;
 /**
  * @see https://docs.npmjs.com/cli/v10/configuring-npm/package-json
@@ -125,7 +125,7 @@ export declare const Package_Json: z.ZodIntersection<z.ZodRecord<z.ZodString, z.
     scripts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     bin: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     files: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    exports: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>, any, Record<string, Record<string, string> | undefined>>>;
+    exports: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>>, any, Record<string, string | Record<string, string> | undefined>>>;
     dependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     devDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     peerDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
@@ -215,7 +215,7 @@ export declare const Package_Json: z.ZodIntersection<z.ZodRecord<z.ZodString, z.
     scripts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     bin: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     files: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    exports: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>, any, Record<string, Record<string, string> | undefined>>>;
+    exports: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>>, any, Record<string, string | Record<string, string> | undefined>>>;
     dependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     devDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     peerDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
@@ -305,7 +305,7 @@ export declare const Package_Json: z.ZodIntersection<z.ZodRecord<z.ZodString, z.
     scripts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     bin: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     files: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    exports: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>, any, Record<string, Record<string, string> | undefined>>>;
+    exports: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>>, any, Record<string, string | Record<string, string> | undefined>>>;
     dependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     devDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     peerDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;

package/dist/package_json.js

@@ -42,7 +42,7 @@ export const Package_Json_Funding = z.union([
     })
         .passthrough(),
 ]);
-export const Package_Json_Exports = z.record(z.record(z.string()).optional());
+export const Package_Json_Exports = z.record(z.union([z.string(), z.record(z.string())]).optional());
 /**
  * @see https://docs.npmjs.com/cli/v10/configuring-npm/package-json
  */
@@ -149,13 +149,22 @@ export const update_package_json = async (dir = paths.root, update, write = true
         await write_package_json(updated_contents);
     return { package_json: updated, changed: true };
 };
+const is_index = (path) => path === 'index.ts' || path === 'index.js';
 export const to_package_exports = (paths) => {
     const sorted = paths
         .slice()
-        .sort((a, b) => (a === 'index.ts' ? -1 : b === 'index.ts' ? 1 : a.localeCompare(b)));
+        .sort((a, b) => (is_index(a) ? -1 : is_index(b) ? 1 : a.localeCompare(b)));
+    // Add the package.json after the index, if one exists.
+    // Including the `./` here ensures we don't conflict with any potential `$lib/package.json`.
+    const final_sorted = is_index(sorted[0])
+        ? [sorted[0]].concat('./package.json', sorted.slice(1))
+        : ['./package.json'].concat(sorted);
     const exports = {};
-    for (const path of sorted) {
-        if (path.endsWith('.json.d.ts')) {
+    for (const path of final_sorted) {
+        if (path === './package.json') {
+            exports['./package.json'] = './package.json';
+        }
+        else if (path.endsWith('.json.d.ts')) {
             const json_path = path.substring(0, path.length - 5);
             exports['./' + json_path] = {
                 default: IMPORT_PREFIX + json_path, // assuming a matching json file
@@ -164,14 +173,14 @@ export const to_package_exports = (paths) => {
         }
         else if (path.endsWith('.ts') && !path.endsWith('.d.ts')) {
             const js_path = replace_extension(path, '.js');
-            const key = path === 'index.ts' ? '.' : './' + js_path;
+            const key = is_index(path) ? '.' : './' + js_path;
             exports[key] = {
                 default: IMPORT_PREFIX + js_path,
                 types: IMPORT_PREFIX + replace_extension(path, '.d.ts'),
             };
         }
         else if (path.endsWith('.js')) {
-            const key = path === 'index.js' ? '.' : './' + path;
+            const key = is_index(path) ? '.' : './' + path;
             exports[key] = {
                 default: IMPORT_PREFIX + path,
                 types: IMPORT_PREFIX + replace_extension(path, '.d.ts'), // assuming JSDoc types

package/dist/package_json.test.js

@@ -45,6 +45,7 @@ test('serialize_package_json fails with bad data', async () => {
 });
 test('to_package_exports', async () => {
     assert.equal(to_package_exports(['a/b.ts']), {
+        './package.json': './package.json',
         './a/b.js': {
             default: './dist/a/b.js',
             types: './dist/a/b.d.ts',
@@ -54,7 +55,13 @@ test('to_package_exports', async () => {
         'a/b/Some_Test_Svelte.svelte',
         'a/b/some_test_ts.ts',
         'a/b/some_test_json.json',
+        'index.ts',
     ]), {
+        '.': {
+            default: './dist/index.js',
+            types: './dist/index.d.ts',
+        },
+        './package.json': './package.json',
         './a/b/some_test_json.json': {
             default: './dist/a/b/some_test_json.json',
         },

package/dist/src_json.test.js

@@ -10,6 +10,7 @@ test('to_package_modules', async () => {
         'fixtures/modules/some_test_ts.ts',
         'fixtures/modules/some_test_json.json',
     ]), undefined, paths.source), {
+        './package.json': { path: 'package.json', declarations: [] },
         './fixtures/modules/some_test_css.css': {
             path: 'fixtures/modules/some_test_css.css',
             declarations: [],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ryanatkn/gro",
-  "version": "0.113.1",
+  "version": "0.114.0",
   "description": "task runner and toolkit extending SvelteKit",
   "icon": "🌰",
   "public": true,
@@ -111,6 +111,7 @@
       "default": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
+    "./package.json": "./package.json",
     "./args.js": {
       "default": "./dist/args.js",
       "types": "./dist/args.d.ts"