versia-pub/server
2
0
Fork 0
mirror of https://github.com/versia-pub/server.git synced 2026-03-13 05:49:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor: 🚨 Make class methods that don't use this static

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-10-03 13:51:19 +02:00
parent 53688095cc
commit 835cdc3f18
No known key found for this signature in database
7 changed files with 47 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

6
classes/plugin/loader.test.ts
View file

@ -56,7 +56,7 @@ describe("PluginLoader", () => {
]);
// biome-ignore lint/complexity/useLiteralKeys: Private method
const directories = await pluginLoader["getDirectories"]("/some/path");
const directories = await PluginLoader["getDirectories"]("/some/path");
expect(directories).toEqual(["dir1", "dir2"]);
});
@ -65,7 +65,7 @@ describe("PluginLoader", () => {
const manifestFile =
// biome-ignore lint/complexity/useLiteralKeys: Private method
await pluginLoader["findManifestFile"]("/some/path");
await PluginLoader["findManifestFile"]("/some/path");
expect(manifestFile).toBe("manifest.json");
});
@ -73,7 +73,7 @@ describe("PluginLoader", () => {
mockReaddir.mockResolvedValue(["index.ts", "otherfile.txt"]);
// biome-ignore lint/complexity/useLiteralKeys: Private method
const hasEntrypoint = await pluginLoader["hasEntrypoint"]("/some/path");
const hasEntrypoint = await PluginLoader["hasEntrypoint"]("/some/path");
expect(hasEntrypoint).toBe(true);
});

18
classes/plugin/loader.ts
View file

@ -18,7 +18,7 @@ export class PluginLoader {
* @param {string} dir - The directory to search.
* @returns {Promise<string[]>} - An array of directory names.
*/
private async getDirectories(dir: string): Promise<string[]> {
private static async getDirectories(dir: string): Promise<string[]> {
const files = await readdir(dir, { withFileTypes: true });
return files.filter((f) => f.isDirectory()).map((f) => f.name);
}
@ -28,7 +28,9 @@ export class PluginLoader {
* @param {string} dir - The directory to search.
* @returns {Promise<string | undefined>} - The manifest file name if found, otherwise undefined.
*/
private async findManifestFile(dir: string): Promise<string | undefined> {
private static async findManifestFile(
dir: string,
): Promise<string | undefined> {
const files = await readdir(dir);
return files.find((f) => f.match(/^manifest\.(json|json5|jsonc)$/));
}
@ -38,7 +40,7 @@ export class PluginLoader {
* @param {string} dir - The directory to search.
* @returns {Promise<boolean>} - True if the entrypoint file is found, otherwise false.
*/
private async hasEntrypoint(dir: string): Promise<boolean> {
private static async hasEntrypoint(dir: string): Promise<boolean> {
const files = await readdir(dir);
return files.includes("index.ts") || files.includes("index.js");
}
@ -79,16 +81,16 @@ export class PluginLoader {
* @returns {Promise<string[]>} - An array of plugin directories.
*/
public async findPlugins(dir: string): Promise<string[]> {
const directories = await this.getDirectories(dir);
const directories = await PluginLoader.getDirectories(dir);
const plugins: string[] = [];
for (const directory of directories) {
const manifestFile = await this.findManifestFile(
const manifestFile = await PluginLoader.findManifestFile(
`${dir}/${directory}`,
);
if (
manifestFile &&
(await this.hasEntrypoint(`${dir}/${directory}`))
(await PluginLoader.hasEntrypoint(`${dir}/${directory}`))
) {
plugins.push(directory);
}
@ -105,7 +107,9 @@ export class PluginLoader {
* @throws Will throw an error if the manifest file is missing or invalid.
*/
public async parseManifest(dir: string, plugin: string): Promise<Manifest> {
const manifestFile = await this.findManifestFile(`${dir}/${plugin}`);
const manifestFile = await PluginLoader.findManifestFile(
`${dir}/${plugin}`,
);
if (!manifestFile) {
throw new Error(`Plugin ${plugin} is missing a manifest file`);