feat: add include files config option

.changeset/crazy-roses-taste.md

@@ -0,0 +1,6 @@
+---
+"jsrepo": minor
+---
+
+feat: Add `includeFiles` to config to allow for serving any file type from a registry
+

.changeset/rich-memes-bet.md

@@ -0,0 +1,6 @@
+---
+"jsrepo": patch
+---
+
+fix: Remove console.log in `build` command
+

schemas/registry-config.json

@@ -150,6 +150,13 @@
 				"type": "string"
 			}
 		},
+		"includeFiles": {
+			"description": "Additional files to include in the manifest. (Supports glob patterns)",
+			"type": "array",
+			"items": {
+				"type": "string"
+			}
+		},
 		"excludeBlocks": {
 			"description": "The names of the blocks that should not be included in the manifest.",
 			"type": "array",

src/commands/build.ts

@@ -19,6 +19,7 @@ const schema = v.object({
 	outputDir: v.optional(v.string()),
 	includeBlocks: v.optional(v.array(v.string())),
 	includeCategories: v.optional(v.array(v.string())),
+	includeFiles: v.optional(v.array(v.string())),
 	excludeBlocks: v.optional(v.array(v.string())),
 	excludeCategories: v.optional(v.array(v.string())),
 	excludeDeps: v.optional(v.array(v.string())),
@@ -48,6 +49,10 @@ const build = new Command('build')
 		'--include-categories [categoryNames...]',
 		'Include only the categories with these names.'
 	)
+	.option(
+		'--include-files [filePatterns...]',
+		'Additional files to include in the manifest. (Supports glob patterns)'
+	)
 	.option('--exclude-blocks [blockNames...]', 'Do not include the blocks with these names.')
 	.option(
 		'--exclude-categories [categoryNames...]',
@@ -103,6 +108,7 @@ async function _build(options: Options) {
 					excludeDeps: options.excludeDeps ?? [],
 					includeBlocks: options.includeBlocks ?? [],
 					includeCategories: options.includeCategories ?? [],
+					includeFiles: options.includeFiles ?? [],
 					excludeBlocks: options.excludeBlocks ?? [],
 					excludeCategories: options.excludeCategories ?? [],
 					allowSubdirectories: options.allowSubdirectories,
@@ -124,6 +130,7 @@ async function _build(options: Options) {
 			if (options.listCategories) mergedVal.listCategories = options.listCategories;
 			if (options.includeBlocks) mergedVal.includeBlocks = options.includeBlocks;
 			if (options.includeCategories) mergedVal.includeCategories = options.includeCategories;
+			if (options.includeFiles) mergedVal.includeFiles = options.includeFiles;
 			if (options.excludeBlocks) mergedVal.excludeBlocks = options.excludeBlocks;
 			if (options.excludeCategories) mergedVal.excludeCategories = options.excludeCategories;
 			if (options.excludeDeps) mergedVal.excludeDeps = options.excludeDeps;

src/commands/init.ts

@@ -785,6 +785,7 @@ const _initRegistry = async (options: Options) => {
 			excludeDeps: [],
 			includeBlocks: [],
 			includeCategories: [],
+			includeFiles: [],
 			excludeBlocks: [],
 			excludeCategories: [],
 			preview: false,

src/commands/publish.ts

@@ -27,6 +27,7 @@ const schema = v.object({
 	dirs: v.optional(v.array(v.string())),
 	includeBlocks: v.optional(v.array(v.string())),
 	includeCategories: v.optional(v.array(v.string())),
+	includeFiles: v.optional(v.array(v.string())),
 	excludeBlocks: v.optional(v.array(v.string())),
 	excludeCategories: v.optional(v.array(v.string())),
 	excludeDeps: v.optional(v.array(v.string())),
@@ -109,6 +110,7 @@ async function _publish(options: Options) {
 					excludeDeps: options.excludeDeps ?? [],
 					includeBlocks: options.includeBlocks ?? [],
 					includeCategories: options.includeCategories ?? [],
+					includeFiles: options.includeFiles ?? [],
 					excludeBlocks: options.excludeBlocks ?? [],
 					excludeCategories: options.excludeCategories ?? [],
 					allowSubdirectories: options.allowSubdirectories,
@@ -131,6 +133,7 @@ async function _publish(options: Options) {
 			if (options.listCategories) mergedVal.listCategories = options.listCategories;
 			if (options.includeBlocks) mergedVal.includeBlocks = options.includeBlocks;
 			if (options.includeCategories) mergedVal.includeCategories = options.includeCategories;
+			if (options.includeFiles) mergedVal.includeFiles = options.includeFiles;
 			if (options.excludeBlocks) mergedVal.excludeBlocks = options.excludeBlocks;
 			if (options.excludeCategories) mergedVal.excludeCategories = options.excludeCategories;
 			if (options.excludeDeps) mergedVal.excludeDeps = options.excludeDeps;

src/utils/build/index.ts

@@ -2,6 +2,7 @@ import fs from 'node:fs';
 import color from 'chalk';
 import { program } from 'commander';
 import type { Ignore } from 'ignore';
+import baseIgnore from 'ignore';
 import path from 'pathe';
 import * as v from 'valibot';
 import { type Block, type Category, categorySchema, type Manifest } from '../../types';
@@ -187,12 +188,15 @@ export function buildBlocksDirectory(
 
 				const blockFiles: string[] = [];
 
+				const shouldIncludeFile = createShouldIncludeFile(config);
+
 				// if the user has enabled allow subdirectories we recursively check each directory and resolve any dependencies
 				const walkFiles = (base: string, files: string[]) => {
 					for (const f of files) {
 						const filePath = path.join(base, f);
 						// relative to the block root
 						const relativeFilePath = filePath.slice(blockDir.length + 1);
+						const relativeToRootDirectory = filePath.replace(cwd, '').replace('/', '');
 
 						if (isTestFile(f)) {
 							hasTests = true;
@@ -213,6 +217,11 @@ export function buildBlocksDirectory(
 							continue;
 						}
 
+						if (shouldIncludeFile(relativeToRootDirectory)) {
+							blockFiles.push(relativeFilePath);
+							continue;
+						}
+
 						if (fs.statSync(filePath).isDirectory()) {
 							if (!config.allowSubdirectories) {
 								console.warn(
@@ -411,6 +420,16 @@ export function shouldIncludeCategory(name: string, config: RegistryConfig) {
 	return true;
 }
 
+export function createShouldIncludeFile(config: RegistryConfig) {
+	if (config.includeFiles.length === 0) return () => false;
+
+	// Dispite it's name, the ignore package can also be used to include files.
+	// It's just a pattern matching library based on the .gitignore syntax.
+	const ignore = baseIgnore().add(config.includeFiles.map((p) => p.replace(/^(\.\/|\/)/, '')));
+
+	return (filePathRelativeToRoot: string) => ignore.ignores(filePathRelativeToRoot);
+}
+
 /** Takes the given file and returns the block name */
 function transformBlockName(file: string) {
 	return path.parse(path.basename(file)).name;

src/utils/config.ts

@@ -76,6 +76,7 @@ export const registryConfigSchema = v.object({
 	outputDir: v.optional(v.string()),
 	includeBlocks: v.optional(v.array(v.string()), []),
 	includeCategories: v.optional(v.array(v.string()), []),
+	includeFiles: v.optional(v.array(v.string()), []),
 	excludeBlocks: v.optional(v.array(v.string()), []),
 	excludeCategories: v.optional(v.array(v.string()), []),
 	doNotListBlocks: v.optional(v.array(v.string()), []),

src/utils/language-support/javascript.ts

@@ -13,7 +13,6 @@ import { formatError, type Lang, resolveImports } from '.';
  * @returns
  */
 export function getJavascriptImports(fileName: string, code: string): string[] {
-	console.log('oxc', oxc);
 	const result = oxc.parseSync(fileName, code);
 
 	const modules: string[] = [];

tests/build.test.ts

@@ -4,6 +4,7 @@ import { afterAll, assert, beforeAll, describe, expect, it } from 'vitest';
 import { cli } from '../src/cli';
 import type { Manifest } from '../src/types';
 import {
+	createShouldIncludeFile,
 	shouldIncludeBlock,
 	shouldIncludeCategory,
 	shouldListBlock,
@@ -65,6 +66,7 @@ describe('build', () => {
 			dirs: ['./src', './'],
 			includeBlocks: [],
 			includeCategories: [],
+			includeFiles: ['src/utils/block-with-asset/asset.txt'],
 			excludeBlocks: [],
 			excludeCategories: ['src'],
 			doNotListBlocks: ['noop'],
@@ -206,6 +208,19 @@ export const highlighter = createHighlighterCore({
 </script>`
 		);
 
+		fs.mkdirSync('./src/utils/block-with-asset', { recursive: true });
+
+		fs.writeFileSync(
+			'./src/utils/block-with-asset/index.ts',
+			`import { fs } from 'node:fs';
+
+const result = fs.readFileSync(new URL('./asset.txt', import.meta.url), 'utf-8');
+console.log(result);
+`
+		);
+
+		fs.writeFileSync('./src/utils/block-with-asset/asset.txt', 'This is an asset file.');
+
 		// build
 
 		await cli.parseAsync([
@@ -321,6 +336,20 @@ export const highlighter = createHighlighterCore({
 								'./log': '{{utils/log}}',
 							},
 						},
+						{
+							_imports_: {},
+							category: 'utils',
+							dependencies: [],
+							devDependencies: [],
+							directory: 'src/utils/block-with-asset',
+							docs: false,
+							files: ['asset.txt', 'index.ts'],
+							list: true,
+							localDependencies: [],
+							name: 'block-with-asset',
+							subdirectory: true,
+							tests: false,
+						},
 						{
 							name: 'form1',
 							category: 'utils',
@@ -395,6 +424,7 @@ const defaultConfig = {
 	excludeDeps: [],
 	includeBlocks: [],
 	includeCategories: [],
+	includeFiles: [],
 	excludeBlocks: [],
 	excludeCategories: [],
 };
@@ -518,3 +548,81 @@ describe('shouldIncludeCategory', () => {
 		).toBe(false);
 	});
 });
+
+describe('shouldIncludeFile', () => {
+	it('does not list if unspecified', () => {
+		expect(
+			createShouldIncludeFile({ ...defaultConfig, includeDocs: false })(
+				'utils/math/asset.txt'
+			)
+		).toBe(false);
+	});
+
+	it('can include a file when referenced directly', () => {
+		expect(
+			createShouldIncludeFile({
+				...defaultConfig,
+				includeFiles: ['/utils/math/asset.txt'],
+				includeDocs: false,
+			})('utils/math/asset.txt')
+		).toBe(true);
+	});
+
+	it('is lenient to leading slashes', () => {
+		expect(
+			createShouldIncludeFile({
+				...defaultConfig,
+				includeFiles: ['/utils/math/asset.txt'],
+				includeDocs: false,
+			})('utils/math/asset.txt')
+		).toBe(true);
+		expect(
+			createShouldIncludeFile({
+				...defaultConfig,
+				includeFiles: ['./utils/math/asset.txt'],
+				includeDocs: false,
+			})('utils/math/asset.txt')
+		).toBe(true);
+	});
+
+	it('it can include all files of a certain extension', () => {
+		expect(
+			createShouldIncludeFile({
+				...defaultConfig,
+				includeFiles: ['**/*.txt'],
+				includeDocs: false,
+			})('utils/math/asset.txt')
+		).toBe(true);
+		expect(
+			createShouldIncludeFile({
+				...defaultConfig,
+				includeFiles: ['**/*.png'],
+				includeDocs: false,
+			})('utils/math/asset.png')
+		).toBe(true);
+		expect(
+			createShouldIncludeFile({
+				...defaultConfig,
+				includeFiles: ['**/*.png'],
+				includeDocs: false,
+			})('utils/math/asset.jpg')
+		).toBe(false);
+	});
+
+	it('it can include all files in a certain directory', () => {
+		expect(
+			createShouldIncludeFile({
+				...defaultConfig,
+				includeFiles: ['utils/math/files-to-include/**'],
+				includeDocs: false,
+			})('utils/math/files-to-include/asset.txt')
+		).toBe(true);
+		expect(
+			createShouldIncludeFile({
+				...defaultConfig,
+				includeFiles: ['utils/math/files-to-include/**'],
+				includeDocs: false,
+			})('utils/math/files-to-include/image.png')
+		).toBe(true);
+	});
+});