@repokit/core 0.0.8 → 0.1.0

package/dist/cjs/CommandParser.js

@@ -16,6 +16,7 @@ const promises_1 = require("node:fs/promises");
 const node_fs_1 = require("node:fs");
 const TaskPooler_1 = require("./TaskPooler");
 const RepoKitCommand_1 = require("./RepoKitCommand");
+/* oxlint-disable typescript-eslint(no-misused-spread) */
 class CommandParser {
     static parse() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -35,7 +36,7 @@ class CommandParser {
             const declaredExports = yield Promise.resolve(`${path}`).then(s => require(s));
             for (const key in declaredExports) {
                 if (declaredExports[key] instanceof RepoKitCommand_1.RepoKitCommand) {
-                    commands.push(Object.assign(Object.assign({}, declaredExports[key].toJSON()), { location: path }));
+                    commands.push(Object.assign(Object.assign({}, declaredExports[key]), { location: path }));
                 }
             }
             return commands;

package/dist/cjs/RepoKitCommand.js

@@ -8,9 +8,5 @@ class RepoKitCommand {
         this.commands = commands;
         this.description = description;
     }
-    toJSON() {
-        const { name, owner, commands, description } = this;
-        return { name, owner, commands, description };
-    }
 }
 exports.RepoKitCommand = RepoKitCommand;

package/dist/cjs/templates/command_template.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Commands = void 0;
+const core_1 = require("@repokit/core");
+/**
+ * Please fill out this command file with your desired settings
+ */
+exports.Commands = new core_1.RepoKitCommand({
+    name: "<Your Package Name>",
+    owner: "<Optional Team or Individual>",
+    description: "<Your Package Description>",
+    commands: {
+        "<your-first-command>": {
+            command: "<insert shell command here>",
+            description: "A description for using your command",
+        },
+        "<your-second-command>": {
+            command: "<insert shell command here>",
+            description: "A description for using your command",
+        },
+        "<your-third-command>": {
+            command: "<insert shell command here>",
+            description: "A description for using your command",
+        },
+    },
+});

package/dist/cjs/templates/configuration_template.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RepoKit = void 0;
+const core_1 = require("@repokit/core");
+/**
+ * Please fill out this config file with your desired
+ * repokit settings
+ */
+exports.RepoKit = new core_1.RepoKitConfig({
+    project: "Your Project Name",
+    commands: {
+        "<your-first-command>": {
+            command: "<insert shell command here>",
+            description: "A description for using your command",
+        },
+        "<your-second-command>": {
+            command: "<insert shell command here>",
+            description: "A description for using your command",
+        },
+        "<your-third-command>": {
+            command: "<insert shell command here>",
+            description: "A description for using your command",
+        },
+    },
+});

package/dist/mjs/CommandParser.js

@@ -4,6 +4,7 @@ import { stat } from "node:fs/promises";
 import { existsSync } from "node:fs";
 import { TaskPooler } from "./TaskPooler.js";
 import { RepoKitCommand } from "./RepoKitCommand.js";
+/* oxlint-disable typescript-eslint(no-misused-spread) */
 export class CommandParser {
     static async parse() {
         const { paths, root } = this.parsePaths();
@@ -20,7 +21,7 @@ export class CommandParser {
         const declaredExports = await import(path);
         for (const key in declaredExports) {
             if (declaredExports[key] instanceof RepoKitCommand) {
-                commands.push({ ...declaredExports[key].toJSON(), location: path });
+                commands.push({ ...declaredExports[key], location: path });
             }
         }
         return commands;

package/dist/mjs/RepoKitCommand.js

@@ -9,8 +9,4 @@ export class RepoKitCommand {
         this.commands = commands;
         this.description = description;
     }
-    toJSON() {
-        const { name, owner, commands, description } = this;
-        return { name, owner, commands, description };
-    }
 }

package/dist/mjs/templates/command_template.js

@@ -0,0 +1,23 @@
+import { RepoKitCommand } from "@repokit/core";
+/**
+ * Please fill out this command file with your desired settings
+ */
+export const Commands = new RepoKitCommand({
+    name: "<Your Package Name>",
+    owner: "<Optional Team or Individual>",
+    description: "<Your Package Description>",
+    commands: {
+        "<your-first-command>": {
+            command: "<insert shell command here>",
+            description: "A description for using your command",
+        },
+        "<your-second-command>": {
+            command: "<insert shell command here>",
+            description: "A description for using your command",
+        },
+        "<your-third-command>": {
+            command: "<insert shell command here>",
+            description: "A description for using your command",
+        },
+    },
+});

package/dist/mjs/templates/configuration_template.js

@@ -0,0 +1,22 @@
+import { RepoKitConfig } from "@repokit/core";
+/**
+ * Please fill out this config file with your desired
+ * repokit settings
+ */
+export const RepoKit = new RepoKitConfig({
+    project: "Your Project Name",
+    commands: {
+        "<your-first-command>": {
+            command: "<insert shell command here>",
+            description: "A description for using your command",
+        },
+        "<your-second-command>": {
+            command: "<insert shell command here>",
+            description: "A description for using your command",
+        },
+        "<your-third-command>": {
+            command: "<insert shell command here>",
+            description: "A description for using your command",
+        },
+    },
+});

package/dist/types/RepoKitCommand.d.ts

@@ -5,10 +5,4 @@ export declare class RepoKitCommand {
     description: string;
     commands: Record<string, ICommand>;
     constructor({ name, description, owner, commands, }: IRepoKitCommand);
-    toJSON(): {
-        name: string;
-        owner: string;
-        commands: Record<string, ICommand>;
-        description: string;
-    };
 }

package/dist/types/templates/command_template.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Please fill out this command file with your desired settings
+ */
+export declare const Commands: any;

package/dist/types/templates/configuration_template.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Please fill out this config file with your desired
+ * repokit settings
+ */
+export declare const RepoKit: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@repokit/core",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "A knowledgebase for your repository - wrapped in a CLI",
   "homepage": "https://github.com/alexfigliolia/repokit#readme",
   "license": "MIT",
@@ -23,11 +23,12 @@
     "access": "public"
   },
   "scripts": {
-    "build:all": "yarn build:ts && yarn lint:all && yarn install:repokit",
+    "build:all": "yarn build:ts && yarn lint:ts && yarn lint:rust && yarn install:repokit",
     "build:rust": "cargo build --release",
     "build:ts": "yarn ts-packager -e src",
     "install:repokit": "yarn build:rust && cargo install --path .",
-    "lint:all": "repokit format:rust && repokit lint:ts",
+    "lint:rust": "cargo clippy --fix --allow-dirty",
+    "lint:ts": "yarn oxlint --type-aware --type-check --report-unused-disable-directives --fix && yarn oxfmt",
     "postinstall": "chmod +x ./install.sh && ./install.sh",
     "repokit": "yarn build:ts && yarn install:repokit && repokit",
     "run:dev": "cargo run --package repokit --bin repokit"

package/src/CommandParser.ts

@@ -6,6 +6,7 @@ import { existsSync } from "node:fs";
 import type { ILocatedCommand } from "./types";
 import { TaskPooler } from "./TaskPooler";
 import { RepoKitCommand } from "./RepoKitCommand";
+/* oxlint-disable typescript-eslint(no-misused-spread) */
 
 export class CommandParser {
   public static async parse() {
@@ -28,7 +29,7 @@ export class CommandParser {
     const declaredExports = await import(path);
     for (const key in declaredExports) {
       if (declaredExports[key] instanceof RepoKitCommand) {
-        commands.push({ ...declaredExports[key].toJSON(), location: path });
+        commands.push({ ...declaredExports[key], location: path });
       }
     }
     return commands;

package/src/RepoKitCommand.ts

@@ -16,9 +16,4 @@ export class RepoKitCommand {
     this.commands = commands;
     this.description = description;
   }
-
-  public toJSON() {
-    const { name, owner, commands, description } = this;
-    return { name, owner, commands, description };
-  }
 }

package/workspaces/configuration/configuration.rs

@@ -1,11 +1,11 @@
 use std::{
     fs::File,
     io,
-    path::{Path, PathBuf},
+    path::Path,
     process::exit,
 };
 
-use crate::logger::logger::Logger;
+use crate::{internal_filesystem::internal_filesystem::InternalFileSystem, logger::logger::Logger};
 
 pub struct Configuration;
 
@@ -17,7 +17,8 @@ impl Configuration {
             return;
         }
         Configuration::welcome();
-        let mut source = File::open(Configuration::template_path()).expect("Template");
+        let template_path = InternalFileSystem::resolve_template("configuration_template.ts");
+        let mut source = File::open(template_path).expect("Template");
         let mut target = File::create(path_buf).expect("creating");
         io::copy(&mut source, &mut target).expect("writing");
         target.sync_all().expect("Flushing");
@@ -36,12 +37,4 @@ impl Configuration {
         Logger::info("Welcome to Repokit! Let's get you setup");
         Logger::info("Creating your configuration file:");
     }
-
-    fn template_path() -> PathBuf {
-        let file_path = file!();
-        let dir = Path::new(file_path)
-            .parent()
-            .expect("Failed to get parent directory");
-        dir.join("configuration_template.ts")
-    }
 }

package/workspaces/external_commands/external_commands.rs

@@ -73,7 +73,7 @@ impl ExternalCommands {
 
     fn allowed(&self, path: &str) -> bool {
         let restricted_paths = ["node_modules", "target", "dist"];
-        let restricted_extensions = ["internal_commands/command_template.ts"];
+        let restricted_extensions = ["templates/command_template.ts"];
         let relative_path = path.replace(format!("{}/", &self.root).as_str(), "");
         if ExternalCommands::restrict(
             &relative_path,

package/workspaces/internal_commands/register_command.rs

@@ -8,13 +8,14 @@ use std::{
 };
 
 use crate::{
-    repokit::interfaces::RepoKitConfig,
     executables::{
         intenal_executable::InternalExecutable,
         internal_executable_definition::InternalExecutableDefinition,
     },
     internal_commands::help::Help,
+    internal_filesystem::internal_filesystem::InternalFileSystem,
     logger::logger::Logger,
+    repokit::interfaces::RepoKitConfig,
 };
 
 pub struct RegisterCommand {
@@ -84,21 +85,14 @@ impl RegisterCommand {
             "Please specify a path to a directory relative to the root of your repository",
         );
     }
-
-    pub fn template_path() -> PathBuf {
-        let file_path = file!();
-        let dir = Path::new(file_path)
-            .parent()
-            .expect("Failed to get parent directory");
-        dir.join("command_template.ts")
-    }
 }
 
 impl InternalExecutable for RegisterCommand {
     fn run(&self, args: Vec<String>, _: &HashMap<String, Box<dyn InternalExecutable>>) {
         Logger::info("Registering a new command");
         let command_path = self.validate_path(args);
-        let mut source = File::open(RegisterCommand::template_path()).expect("Template");
+        let template_path = InternalFileSystem::resolve_template("command_template.ts");
+        let mut source = File::open(template_path).expect("Template");
         let mut target = File::create(&command_path).expect("creating");
         io::copy(&mut source, &mut target).expect("writing");
         target.sync_all().expect("Flushing");

package/workspaces/internal_commands/typescript_command.rs

@@ -1,11 +1,11 @@
-use std::path::{Path, PathBuf};
+use std::path::Path;
 
-use normalize_path::NormalizePath;
 use serde_json::from_str;
 
 use crate::{
     configuration::configuration::Configuration,
     executor::executor::Executor,
+    internal_filesystem::internal_filesystem::InternalFileSystem,
     logger::logger::Logger,
     repokit::interfaces::{RepoKitCommand, RepoKitConfig},
 };
@@ -20,9 +20,8 @@ impl TypescriptCommand {
     }
 
     pub fn parse_configuration(&self) -> RepoKitConfig {
-        let executable = self.path_to_command("parse_configuration.ts");
-        Logger::info(&executable);
-        let stdout = self.execute(format!("{executable} --root {}", &self.root).as_str());
+        let executable = InternalFileSystem::resolve_command("parse_configuration.ts");
+        let stdout = self.with_tsx(format!("{executable} --root {}", &self.root).as_str());
         Logger::info(&stdout);
         if stdout.is_empty() {
             Configuration::create(&self.root);
@@ -34,32 +33,14 @@ impl TypescriptCommand {
 
     pub fn parse_commands(&self, path_list: Vec<String>) -> Vec<RepoKitCommand> {
         let paths = path_list.join(",");
-        let executable = self.path_to_command("parse_commands.ts");
+        let executable = InternalFileSystem::resolve_command("parse_commands.ts");
         let stdout =
-            self.execute(format!("{executable} --paths {paths} --root {}", self.root).as_str());
+            self.with_tsx(format!("{executable} --paths {paths} --root {}", self.root).as_str());
         let commands: Vec<RepoKitCommand> = serde_json::from_str(&stdout).expect("parse");
         commands
     }
 
-    fn commands_dir(&self) -> PathBuf {
-        let file_path = file!();
-        let origin = env!("CARGO_MANIFEST_DIR");
-        let dir = Path::new(file_path)
-            .parent()
-            .expect("Failed to get parent directory");
-        let resolved = Path::new(origin).join(dir);
-        resolved.join("../../src/commands").normalize()
-    }
-
-    fn path_to_command(&self, command_file: &str) -> String {
-        self.commands_dir()
-            .join(command_file)
-            .into_os_string()
-            .into_string()
-            .expect("Cannot construct path")
-    }
-
-    fn execute(&self, args: &str) -> String {
+    fn with_tsx(&self, args: &str) -> String {
         Executor::exec(format!("npx tsx {}", args), |cmd| {
             cmd.current_dir(Path::new(&self.root))
         })

package/workspaces/internal_filesystem/internal_filesystem.rs

@@ -0,0 +1,54 @@
+use normalize_path::NormalizePath;
+use std::path::{Path, PathBuf};
+
+pub struct InternalFileSystem;
+
+impl InternalFileSystem {
+    pub fn absolute(segment: &str) -> PathBuf {
+        let origin = env!("CARGO_MANIFEST_DIR");
+        let path = Path::new(origin);
+        path.join(segment).normalize()
+    }
+
+    pub fn commands_directory() -> PathBuf {
+        InternalFileSystem::source_internal("commands")
+    }
+
+    pub fn templates_directory() -> PathBuf {
+        InternalFileSystem::source_internal("templates")
+    }
+
+    pub fn resolve_command(file_name: &str) -> String {
+        InternalFileSystem::path_buf_to_str(
+            InternalFileSystem::commands_directory().join(file_name),
+        )
+    }
+
+    pub fn resolve_template(file_name: &str) -> String {
+        InternalFileSystem::path_buf_to_str(
+            InternalFileSystem::templates_directory().join(file_name),
+        )
+    }
+
+    fn source_internal(path: &str) -> PathBuf {
+        let src = InternalFileSystem::absolute(format!("./src/{path}").as_str());
+        if InternalFileSystem::is_in_node_modules(&src) {
+            return InternalFileSystem::absolute(format!("./dist/{path}").as_str());
+        }
+        src
+    }
+
+    fn path_buf_to_str(buffer: PathBuf) -> String {
+        buffer
+            .into_os_string()
+            .into_string()
+            .expect("Cannot construct path")
+    }
+
+    fn is_in_node_modules(path: &PathBuf) -> bool {
+        path.as_os_str()
+            .to_str()
+            .expect("blah")
+            .contains("node_modules")
+    }
+}

package/workspaces/internal_filesystem/mod.rs

@@ -0,0 +1 @@
+pub mod internal_filesystem;

package/workspaces/main.rs

@@ -9,6 +9,7 @@ mod executables;
 mod executor;
 mod external_commands;
 mod internal_commands;
+mod internal_filesystem;
 mod logger;
 mod repokit;
 mod validations;