@kokiito0926/fs2xml 0.0.1 → 0.0.3

package/README.md

@@ -1,7 +1,7 @@
 ## fs2xml
 
-fs2xmlを用いれば、ファイルをXML形式でまとめることができます。  
-ファイルをXML形式でまとめてから、大規模言語モデルに与えたりすることができるので便利かもしれません。
+fs2xmlは、ファイルをXML形式でまとめることができます。  
+ファイルをXML形式でまとめるようにすると、大規模言語モデルに与えやすくなります。
 
 ## インストール
 
@@ -9,11 +9,44 @@ fs2xmlを用いれば、ファイルをXML形式でまとめることができ
 $ npm install --global @kokiito0926/fs2xml
 ```
 
-## 実行方法
+## 使用方法
+
+カレントディレクトリ内のすべてのファイルをXML形式でまとめます。
+
+```bash
+$ fs2xml
+```
+
+特定のディレクトリ内のすべてのファイルをXML形式でまとめます。
+
+```bash
+$ fs2xml "./src/**/*"
+```
+
+特定のディレクトリ内の特定の拡張子のみを対象にして、XML形式でまとめます。
+
+```bash
+$ fs2xml "./src/**/*.txt"
+```
+
+--ignoreのオプションを用いると、特定のパターンを除外することができます。  
+現状の実装では、現在の作業中のディレクトリの.gitignoreが読み込まれ、そのパターンが自動的に適用されます。
 
 ```bash
-$ fs2xml ../../workspace/
-$ fs2xml ../../workspace/ > ./example.xml
+$ fs2xml "./src/**/*" --ignore "./src/test/**" --ignore "**/*.log"
+```
+
+## 出力例
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<files>
+	<file>
+		<name>example.js</name>
+		<path>src/example.js</path>
+		<content>console.log("Hello world!");</content>
+	</file>
+</files>
 ```
 
 ## ライセンス

package/index.js

@@ -1,13 +1,42 @@
 #!/usr/bin/env node
 
-// >> $ ./index.js ../../workspace/
-// >> $ ./index.js ../../workspace/ > ./example.xml
+// >> $ ./index.js "./example/example.txt"
+// >> $ ./index.js "./example/sub/example.js"
 
-import { fs, path, minimist } from "zx";
+// >> $ ./index.js "./example/**/*.txt"
+// >> $ ./index.js "./example/**/*.txt" --ignore "./example/ignore/**"
+
+import { fs, path, minimist, glob } from "zx";
 import { create } from "xmlbuilder2";
+import ignore from "ignore";
 
 const args = minimist(process.argv.slice(2));
-const target = args._[0] || ".";
+const target = args._[0] || "**/*";
+
+let ig = ignore();
+const gitignorePath = path.join(process.cwd(), ".gitignore");
+if (fs.existsSync(gitignorePath)) {
+	const gitignoreContent = await fs.readFile(gitignorePath, "utf8");
+	ig.add(gitignoreContent);
+}
+
+const defaultIgnore = ["node_modules/**", ".git/**"];
+
+const userIgnore = args.ignore ? (Array.isArray(args.ignore) ? args.ignore : [args.ignore]) : [];
+
+const ignorePatterns = [...defaultIgnore, ...userIgnore].filter(Boolean);
+
+let files = await glob(target, {
+	ignore: ignorePatterns,
+	nodir: true,
+	dot: true,
+});
+
+files = files.filter((file) => {
+	const relativePath = path.relative(process.cwd(), file);
+	if (relativePath === "") return true;
+	return !ig.ignores(relativePath);
+});
 
 async function getFileData(filePath) {
 	let content = await fs.readFile(filePath, "utf8");
@@ -23,17 +52,15 @@ async function getFileData(filePath) {
 	};
 }
 
-if (!fs.existsSync(target)) {
-	console.error(`Error: Cannnot access '${target}'; No such file or directory.`);
-	process.exit(1);
+if (files.length === 0) {
+	process.stderr.write(`No files matched the pattern: ${pattern}\n`);
+	process.exit(0);
 }
 
-const stats = await fs.stat(target);
-
 let xmlOutput = "";
 
-if (stats.isFile()) {
-	const data = await getFileData(target);
+if (files.length === 1) {
+	const data = await getFileData(files[0]);
 	if (!data) {
 		process.exit(1);
 	}
@@ -48,24 +75,13 @@ if (stats.isFile()) {
 		.up()
 		.ele("content")
 		.txt(data.content)
+		// .dat(data.content)
 		.up()
 		.end({ prettyPrint: true });
 } else {
-	const files = await fs.readdir(target, { recursive: true });
-	if (!files.length) {
-		process.exit(1);
-	}
-	// console.log(files);
-
 	const allFiles = [];
 	for (const file of files) {
-		const filePath = path.join(target, file);
-		const fStats = await fs.stat(filePath);
-		if (fStats.isDirectory()) continue;
-
-		// console.error(file);
-
-		const fileData = await getFileData(filePath);
+		const fileData = await getFileData(file);
 		if (!fileData) continue;
 
 		allFiles.push(fileData);
@@ -86,6 +102,7 @@ if (stats.isFile()) {
 			.up()
 			.ele("content")
 			.txt(f.content)
+			// .dat(f.content)
 			.up()
 			.up();
 	}

package/package.json

@@ -1,8 +1,8 @@
 {
 	"name": "@kokiito0926/fs2xml",
-	"version": "0.0.1",
+	"version": "0.0.3",
 	"private": false,
-	"description": "fs2xmlを用いれば、ファイルをXML形式でまとめることができます。",
+	"description": "ファイルをXML形式でまとめることができます。",
 	"keywords": [
 		"cli",
 		"bash",
@@ -34,6 +34,7 @@
 		"test": "node --test"
 	},
 	"dependencies": {
+		"ignore": "^7.0.5",
 		"xmlbuilder2": "^4.0.3",
 		"zx": "^8.8.4"
 	},