diff --git a/README.md b/README.md deleted file mode 100644 index 2934399..0000000 --- a/README.md +++ /dev/null @@ -1,24 +0,0 @@ -## Running the Extension - -- Run `pnpm install` in this folder. This installs all necessary npm modules in both the client and server folder -- Open VS Code on this folder. -- Press Ctrl+Shift+B to compile the client and server. -- Switch to the Debug viewlet. -- Select `Launch Client` from the drop down. -- Run the launch config. -- If you want to debug the server as well use the launch configuration `Attach to Server` -- In the [Extension Development Host] instance of VSCode, open a `test.js.doodl` - - Type `console.| }` to try CSS completion - -## Build .vsix - -- Run `pnpm run pack` in this folder -- `packages/vscode/vscode-doodl-0.0.1.vsix` will be created, and you can manual install it to VSCode. - -## References - -- https://github.com/volarjs/starter -- https://code.visualstudio.com/api/language-extensions/embedded-languages -- https://github.com/microsoft/vscode-extension-samples/tree/main/lsp-embedded-language-service -- https://github.com/analogjs/language-tools diff --git a/README.md b/README.md new file mode 120000 index 0000000..b72cad8 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +packages/compiler/README.md \ No newline at end of file diff --git a/packages/compiler/README.md b/packages/compiler/README.md new file mode 100644 index 0000000..17d5cd0 --- /dev/null +++ b/packages/compiler/README.md @@ -0,0 +1,32 @@ +# Doodl ✏︎ + +> A modern type-safe templating engine + +```dood + + +import {v4} from "uuid"; + +const data = { + hello: !!v4 ? 123 : null +}; + + + + +{ + "//": "Interpolate values with << >>", + "test": <> +} + +``` + +# Installation + +```shell +npm install doodl +``` + +# Prerequisites + +- Node v22.18+ \ No newline at end of file diff --git a/packages/compiler/package.json b/packages/compiler/package.json index 0d25138..30717b3 100644 --- a/packages/compiler/package.json +++ b/packages/compiler/package.json @@ -2,7 +2,18 @@ "name": "doodl", "type": "module", "version": "0.0.1", - "description": "", + "description": "A modern type-safe templating engine", + "author": "crutchcorn", + "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/crutchcorn/doodl.git", + "directory": "packages/compiler" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/crutchcorn" + }, "scripts": { "build": "vite build", "test:lib": "vitest", @@ -11,7 +22,6 @@ "test:attw": "attw --profile esm-only --pack ." }, "keywords": [], - "author": "", "devDependencies": { "@arethetypeswrong/cli": "^0.18.2", "@types/node": "^24.5.2", @@ -33,4 +43,4 @@ "import": "./dist/index.js" } } -} +} \ No newline at end of file