{"id":18537228,"url":"https://github.com/budarin/ts-css-loader","last_synced_at":"2026-05-03T21:32:26.678Z","repository":{"id":82752095,"uuid":"148833908","full_name":"budarin/ts-css-loader","owner":"budarin","description":"Webpack loader to generate typescript definitions for css-modules for isomorphic apps","archived":false,"fork":false,"pushed_at":"2020-05-26T16:23:41.000Z","size":495,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-19T23:59:04.955Z","etag":null,"topics":["css-modules","isomorphic-applications","style-loader","typescript","webpack-loader"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/budarin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-14T19:37:36.000Z","updated_at":"2021-06-15T14:06:11.000Z","dependencies_parsed_at":"2023-03-12T16:43:31.071Z","dependency_job_id":null,"html_url":"https://github.com/budarin/ts-css-loader","commit_stats":{"total_commits":104,"total_committers":2,"mean_commits":52.0,"dds":0.009615384615384581,"last_synced_commit":"75876c5f27018d535e55fc5816c5d67acb9ec077"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/budarin/ts-css-loader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/budarin%2Fts-css-loader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/budarin%2Fts-css-loader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/budarin%2Fts-css-loader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/budarin%2Fts-css-loader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/budarin","download_url":"https://codeload.github.com/budarin/ts-css-loader/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/budarin%2Fts-css-loader/sbom","scorecard":{"id":257200,"data":{"date":"2025-08-11","repo":{"name":"github.com/budarin/ts-css-loader","commit":"75876c5f27018d535e55fc5816c5d67acb9ec077"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/23 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 12 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"64 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2","Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w","Warn: Project is vulnerable to: GHSA-434g-2637-qmqr","Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m","Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw","Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p","Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747","Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh","Warn: Project is vulnerable to: GHSA-3gx7-xhv7-5mx3","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-vvj3-85vf-fgmw","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6","Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59","Warn: Project is vulnerable to: GHSA-566m-qj78-rww5","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx","Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq","Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T09:57:34.971Z","repository_id":82752095,"created_at":"2025-08-17T09:57:34.971Z","updated_at":"2025-08-17T09:57:34.971Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32586187,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["css-modules","isomorphic-applications","style-loader","typescript","webpack-loader"],"created_at":"2024-11-06T19:37:30.768Z","updated_at":"2026-05-03T21:32:26.647Z","avatar_url":"https://github.com/budarin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @budarin/ts-css-loader\n\nThis loader is a fork of the well-known loader [typings-for-css-modules-loader](https://github.com/Jimdo/typings-for-css-modules-loader)\n\nThe purpose of creating yet another typescript generation loader for css-modules is the ability to use it in an isomorphic application in conjunction with [style-loader/usable](https://github.com/webpack-contrib/style-loader)(is used in browser to use or unse component's stylesheets) and [fake-style-loader](https://github.com/dferber90/fake-style-loader)(is used on server side to get source css from component's stylesheet).\n\n`style-loader/usable` adds 2 methods to the css-modules interface:\n\n-   `use: Function`\n-   `unuse: Function`\n\n`fake-style-loader` adds properties to the css-modules interface:\n\n-   `source: String`\n-   all classnames into default exported object\n\n## `Installation`\n\nInstall via npm `npm install --save-dev @budarin/ts-css-loader`\n\n## `Options`\n\nAll options are available only when the parameter `modules` set to `true`(see options for [css-loader](https://github.com/webpack-contrib/css-loader#options))\n\n|                   Name                    |    Type     | Default | Description                                                                |\n| :---------------------------------------: | :---------: | :-----: | :------------------------------------------------------------------------- |\n|             **[`EOL`](#EOL)**             | `{String}`  | `CRLF`  | {'CRLF', 'LF'}                                                             |\n| **[`onlyNamedExport`](#onlyNamedExport)** | `{Boolean}` | `false` | Export only named items of interface                                       |\n|         **[`browser`](#browser)**         | `{Boolean}` | `false` | Add `use` and `unuse` methods to interface and all classnames in flat view |\n|          **[`server`](#server)**          | `{Boolean}` | `false` | Add `source` property to interface                                         |\n|        **[`tabWidth`](#tabWidth)**        | `{Number}`  |    4    | Set tabWidth for indentation                                               |\n|          **[`silent`](#silent)**          | `{Boolean}` | `false` | To silence the loader                                                      |\n|          **[`banner`](#banner)**          | `{Boolean}` | `false` | Adds a \"banner\" prefix to each generated \\*.d.ts                           |\n\nthe other parameters are the same as the `css-loader`:\n\nThis loader should be used instead of` css-loader ' because inside it uses it.\n\nAn example of using webpack.config:\n\n```js\n    test: /\\.css$/,\n    use: [\n        {\n            loader: 'style-loader',\n        },\n        {\n            loader: '@budarin/ts-css-loader',\n            options: {\n                modules: true,\n            },\n        }\n    ]\n```\n\nfor style file `app.css`:\n\n```css\n.foo {\n    color: red;\n}\n```\n\nthe loader will generate a type definition:\n\n```ts\ndeclare interface IAppCss {\n    readonly foo: string;\n}\ndeclare const styles: IAppCss;\n\nexport default styles;\n```\n\n### `EOL`\n\nDefault: `'CRLF'`.\n\nDefines a line separator in type definition file and must be equal to the parameter set in `git` to prevent constant overwriting of type definition file.\nThis parameter can take one of these acronims `{'CRLF','LF`}'\n\n```js\n    test: /\\.css$/,\n    use: [\n        {\n            loader: 'style-loader',\n        },\n        {\n            loader: '@budarin/ts-css-loader',\n            options: {\n                modules: true,\n                EOL: 'LF'\n            }\n        }\n    ]\n```\n\n### `onlyNamedExport`\n\nDefault: `false`.\n\nThis parameter determines whether only named exports are present in the module interface\n\n```js\n    test: /\\.css$/,\n    use: [\n        {\n            loader: 'style-loader',\n        },\n        {\n            loader: '@budarin/ts-css-loader',\n            options: {\n                modules: true,\n                onlyNamedExport: true\n            }\n        }\n    ]\n```\n\noutput:\n\n```ts\nexport const foo: string;\n```\n\n### `browser`\n\nDefault: `false`.\n\nThe parameter determines the presence of `style-loader/disable` methods in the interface: `use` and `unuse`.\n\n```js\n    test: /\\.css$/,\n    use: [\n        {\n            loader: 'style-loader/usable',\n        },\n        {\n            loader: '@budarin/ts-css-loader',\n            options: {\n                modules: true,\n                browser: true\n            }\n        }\n    ]\n```\n\noutput:\n\n```ts\ndeclare interface IAppCss {\n    readonly locals: {\n        readonly foo: string;\n    };\n    readonly use: Function;\n    readonly unuse: Function;\n}\ndeclare const styles: IAppCss;\n\nexport default styles;\n```\n\n### `server`\n\nDefault: `false`.\n\nDetermines the presence of the interface property `source: string` for `fake-style-loader` and presene all css classes in default export\n\n```js\n    test: /\\.css$/,\n    use: [\n        {\n            loader: 'fake-style-loader',\n        },\n        {\n            loader: '@budarin/ts-css-loader',\n            options: {\n                modules: true,\n                server: true\n            }\n        }\n    ]\n```\n\noutput:\n\n```ts\ndeclare interface IAppCss {\n    readonly foo: string;\n    readonly source: string;\n}\ndeclare const styles: IAppCss;\n\nexport default styles;\n```\n\n### `tabWidth`\n\nDefault: 4.\n\nNumber of spaces it should use per tab\n\n### `silent`\n\nDefault: `false`.\n\nTo silence the loader because you get annoyed by its warnings or for other reasons, you can simply pass the \"silent\" query to the loader and it will shut up.\ne.g.:\n\n```js\n    test: /\\.css$/,\n    use: [\n        {\n            loader: 'style-loader',\n        },\n        {\n            loader: '@budarin/ts-css-loader',\n            options: {\n                modules: false,\n            }\n        }\n    ]\n```\n\n### `banner`\n\nDefault: `false`..\n\nTo add a \"banner\" prefix to each generated `*.d.ts` file, you can pass a string to this option as shown below. The prefix is quite literally prefixed into the generated file, so please ensure it conforms to the type definition syntax.\n\n```js\n    test: /\\.css$/,\n    use: [\n        {\n            loader: 'style-loader',\n        },\n        {\n            loader: '@budarin/ts-css-loader',\n            options: {\n                modules: true,\n                banner: \"// This file is automatically generated file.\\n// Please do not change this file!\"\n            }\n        }\n    ]\n```\n\noutput:\n\n```ts\n// This file is automatically generated file\n// Please do not change this file!\"\ndeclare interface IAppCss {\n    readonly locals: {\n        readonly foo: string;\n    };\n}\ndeclare const styles: IAppCss;\n\nexport default styles;\n```\n\nFor isomorphic applications, you can use the following configuration:\n\n```js\n    test: /\\.css$/,\n    use: [\n        {\n            loader: ...\n        },\n        {\n            loader: '@budarin/ts-css-loader',\n            options: {\n                modules: true,\n                browser: true,\n                server: true\n            }\n        }\n    ]\n```\n\noutput:\n\n```ts\ndeclare interface IAppCss {\n    readonly locals: {\n        readonly foo: string;\n    };\n    readonly use: Function;\n    readonly unuse: Function;\n    readonly source: string;\n}\ndeclare const styles: IAppCss;\n\nexport default styles;\n```\n\n### using `onlyNamedExport` with the `camelCase`\n\nUsing the `onlyNamedExport` as well as the `camelCase` options the generated file will look as follow:\n\n```ts\nexport const someClass: string;\nexport const someOtherClass: string;\nexport const someClassSayWhat: string;\n```\n\n### Example in Visual Studio Code\n\n![typed-css-modules](https://cloud.githubusercontent.com/assets/749171/16340497/c1cb6888-3a28-11e6-919b-f2f51a282bba.gif)\n\nIf you encounter the following errors:\n\n```\nerror TS1192: Module '\"xxxxx/xxxx/src/style.sass\"' has no default export.\n```\n\nmaybe you should export the styles as following:\n\n```\nimport * as styles from './style.sass';\n```\n\n## Support\n\nAs the loader just acts as an intermediary it can handle all kind of css preprocessors (`sass`, `scss`, `stylus`, `less`, ...).\nThe only requirement is that those preprocessors have proper webpack loaders defined - meaning they can already be loaded by webpack anyways.\n\n## Requirements\n\nThe loader uses `css-loader`(https://github.com/webpack/css-loader) under the hood. Thus it is a peer-dependency and the expected loader to create CSS Modules.\n\n## Known issues\n\n### Webpack rebuilds / builds slow\n\nAs the loader generates typing files, it is wise to tell webpack to ignore them.\nThe fix is luckily very simple. Webpack ships with a \"WatchIgnorePlugin\" out of the box.\nSimply add this to your webpack plugins:\n\n```\nplugins: [\n    new webpack.WatchIgnorePlugin([\n      /css\\.d\\.ts$/\n    ]),\n    ...\n  ]\n```\n\nwhere `css` is the file extension of your style files. If you use `sass` you need to put `sass` here instead. If you use `less`, `stylus` or any other style language use their file ending.\n\n### Typescript doesnt find the typings\n\nAs the webpack process is independent from your typescript \"runtime\" it may take a while for typescript to pick up the typings.\nAny hints on how this could be fixed deterministically are welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbudarin%2Fts-css-loader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbudarin%2Fts-css-loader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbudarin%2Fts-css-loader/lists"}