Skip to content

📝 Clarify double quotes in README #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 6, 2024
Merged

📝 Clarify double quotes in README #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,14 @@ npm install --save-dev css-typed
Run `css-typed` and pass it a glob targeting your CSS files.

```shell
npx css-typed 'src/**/*.css'
npx css-typed "src/**/*.css"
```

This will generate `.d.css.ts` files next to the original source files.

> **Note**
See the [run script recipe](#run-script) for adding to your `package.json`.

> [!NOTE]
>
> A CSS module file with the name `foo.module.css` will emit `foo.module.d.css.ts`.

Expand Down Expand Up @@ -114,7 +116,7 @@ For example, `my-class` becomes `myClass` and you cannot use `my-class` in JS/TS
Modern bundlers or build system such as Vite and Gatsby support this transformation.
The default matches CSS naming practices (`kebab-case`).

> **IMPORTANT**
> [!IMPORTANT]
>
> Note that `camelCase` and `dashes` MAY have TypeScript bugs.
> TypeScript 5.6 may help with the named exports for these.
Expand All @@ -127,18 +129,23 @@ The default matches CSS naming practices (`kebab-case`).

### Run script

To run it as part of your build, you will likely include it as a run script, maybe as `codegen` or `pretsc`.
To run it as part of your build, you will likely include it as a run script, maybe as `codegen`, `css-typed`, or `pretsc`.

```json
{
"scripts": {
"codegen": "css-typed \"src/**/*.css\"",
"css-typed": "css-typed \"src/**/*.css\"",
"pretsc": "css-typed \"src/**/*.css\"",
"tsc": "tsc"
}
}
```

> [!NOTE]
>
> Use `\"` in your run scripts for Windows OS compatibility.

### Watch

The CLI does not have built-in watch support.
Expand Down