feat: simplify interfaces

Author: adbayb

.changeset/silver-phones-tap.md

@@ -0,0 +1,15 @@
+---
+"@sdk-usage/cli": minor
+"@sdk-usage/core": minor
+"@sdk-usage/plugin-jsx": minor
+"@sdk-usage/plugin-typescript": minor
+---
+
+This release refines and simplifies the interfaces (considered as breaking changes but listed as minor prior to the stable major release).
+The following modifications have been introduced:
+
+- `@sdk-usage/core`: `createContext` has been renamed to `createInstance`.
+- `@sdk-usage/core`: `createSyntaxPlugin` has been renamed to `createPlugin`.
+- `@sdk-usage/core`: `plugins` accepts now directly an array of plugins.
+- `@sdk-usage/plugin-jsx`: `@sdk-usage/plugin-syntax-jsx` is deprecated (will be removed soon from the registry) and renamed to `@sdk-usage/plugin-jsx`.
+- `@sdk-usage/plugin-typescript`: `@sdk-usage/plugin-syntax-typescript` is deprecated (will be removed soon from the registry) and renamed to `@sdk-usage/plugin-typescript`.

.changeset/welcome.md

@@ -1,8 +1,8 @@
 ---
 "@sdk-usage/cli": minor
 "@sdk-usage/core": minor
-"@sdk-usage/plugin-syntax-jsx": minor
-"@sdk-usage/plugin-syntax-typescript": minor
+"@sdk-usage/plugin-jsx": minor
+"@sdk-usage/plugin-typescript": minor
 ---
 
 v0.1.0 release 🚀

applications/cli/package.json

@@ -35,8 +35,8 @@
 	},
 	"dependencies": {
 		"@sdk-usage/core": "workspace:^",
-		"@sdk-usage/plugin-syntax-jsx": "workspace:^",
-		"@sdk-usage/plugin-syntax-typescript": "workspace:^"
+		"@sdk-usage/plugin-jsx": "workspace:^",
+		"@sdk-usage/plugin-typescript": "workspace:^"
 	},
 	"devDependencies": {
 		"@types/node": "22.10.6",

applications/cli/src/index.ts

@@ -1,15 +1,15 @@
 import process from "node:process";
 
-import typescriptSyntaxPlugin from "@sdk-usage/plugin-syntax-typescript";
-import jsxSyntaxPlugin from "@sdk-usage/plugin-syntax-jsx";
-import { createContext } from "@sdk-usage/core";
+import typescriptSyntaxPlugin from "@sdk-usage/plugin-typescript";
+import jsxSyntaxPlugin from "@sdk-usage/plugin-jsx";
+import { createInstance } from "@sdk-usage/core";
 
-const context = createContext(process.cwd(), {
-	plugins: { syntax: [jsxSyntaxPlugin, typescriptSyntaxPlugin] },
+const instance = createInstance(process.cwd(), {
+	plugins: [jsxSyntaxPlugin, typescriptSyntaxPlugin],
 });
 
 const main = async () => {
-	const items = await context.getItems();
+	const items = await instance.getItems();
 
 	console.log(JSON.stringify(items, null, 2), items.length);
 };

libraries/core/src/createContext.ts renamed to libraries/core/src/createInstance.ts

@@ -3,8 +3,8 @@ import { readFileSync } from "node:fs";
 import type { Package } from "./types";
 import { scan } from "./modules/scanner";
 import type { ScanOptions } from "./modules/scanner";
+import type { Plugin } from "./modules/plugin";
 import { parse } from "./modules/parser";
-import type { ParseOptions } from "./modules/parser";
 import { require, resolvePackageJson } from "./helpers";
 import { createItem } from "./entities/item";
 import type { Item } from "./entities/item";
@@ -15,16 +15,19 @@ type Options = Partial<
 		 * Only analyze components imported from the specificied module list.
 		 */
 		includeModules: string[];
+		/**
+		 * A list of plugins to enable.
+		 */
+		plugins: Plugin[];
 		/**
 		 * Attempt to resolve installed versions of modules. If false or not possible, the specified version from the package.json will be used.
 		 * @default false
 		 */
 		resolveInstalledVersions: boolean;
 	}
-> &
-	Pick<ParseOptions, "plugins">;
+>;
 
-export const createContext = (path: string, options: Options) => {
+export const createInstance = (path: string, options: Options) => {
 	return {
 		async getItems() {
 			const projects = await scan(path);
@@ -87,7 +90,7 @@ export const createContext = (path: string, options: Options) => {
 								}),
 							);
 						},
-						plugins: options.plugins,
+						plugins: options.plugins ?? [],
 					});
 				}
 			}

libraries/core/src/index.ts

@@ -1,2 +1,2 @@
-export { createContext } from "./createContext";
-export { createSyntaxPlugin } from "./modules/plugin";
+export { createInstance } from "./createInstance";
+export { createPlugin } from "./modules/plugin";

libraries/core/src/modules/parser/parse.ts

@@ -2,16 +2,13 @@ import { parse as swcParse } from "@swc/core";
 import type { Module } from "@swc/core";
 import { visit } from "@open-vanilla/visitor";
 
-import type { Plugins } from "../plugin";
+import type { Plugin } from "../plugin";
 import type { Import, Nodes, Primitive } from "../../types";
 import type { ItemDTO } from "../../entities/item";
 
 export type ParseOptions = {
 	onAdd: (item: ItemDTO) => void;
-	/**
-	 * A list of plugins to enable.
-	 */
-	plugins: Plugins;
+	plugins: Plugin[];
 };
 
 export const parse = async (code: string, { onAdd, plugins }: ParseOptions) => {
@@ -54,7 +51,7 @@ export const parse = async (code: string, { onAdd, plugins }: ParseOptions) => {
 		},
 	};
 
-	for (const plugin of plugins.syntax) {
+	for (const plugin of plugins) {
 		const pluginOutput = plugin(context, {
 			getJSXAttributeValue,
 		});

libraries/core/src/modules/plugin/createSyntaxPlugin.ts renamed to libraries/core/src/modules/plugin/createPlugin.ts

@@ -1,11 +1,11 @@
 import type { Import, Nodes, Primitive } from "../../types";
 import type { ItemDTO } from "../../entities/item";
 
-export const createSyntaxPlugin = (input: SyntaxPlugin) => {
+export const createPlugin = (input: Plugin) => {
 	return input;
 };
 
-export type SyntaxPlugin = (
+export type Plugin = (
 	context: {
 		// TODO: do not expose setters (read-only context for getter purposes)
 		imports: Map<Import["alias"], Import>;

libraries/core/src/modules/plugin/index.ts

@@ -1,2 +1,2 @@
-export type { Plugins } from "./types";
-export { createSyntaxPlugin } from "./createSyntaxPlugin";
+export type { Plugin } from "./createPlugin";
+export { createPlugin } from "./createPlugin";