{"id":23413131,"url":"https://github.com/dsc8x/sass-vars-loader","last_synced_at":"2025-04-12T04:55:04.249Z","repository":{"id":10572868,"uuid":"66210561","full_name":"dsc8x/sass-vars-loader","owner":"dsc8x","description":"Use Sass variables defined in Webpack config or in external Javascript or JSON files","archived":false,"fork":false,"pushed_at":"2023-01-14T01:09:30.000Z","size":4354,"stargazers_count":119,"open_issues_count":30,"forks_count":23,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-12T04:54:55.964Z","etag":null,"topics":["hmr","hot-reload","javascript","json","loader","sass","sass-vars","scss","variables","webpack","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/dsc8x.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-21T17:10:17.000Z","updated_at":"2024-02-05T01:35:06.000Z","dependencies_parsed_at":"2023-01-16T19:46:30.639Z","dependency_job_id":null,"html_url":"https://github.com/dsc8x/sass-vars-loader","commit_stats":null,"previous_names":["dsc8x/sass-vars-loader","epegzz/sass-vars-loader"],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsc8x%2Fsass-vars-loader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsc8x%2Fsass-vars-loader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsc8x%2Fsass-vars-loader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsc8x%2Fsass-vars-loader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dsc8x","download_url":"https://codeload.github.com/dsc8x/sass-vars-loader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248519472,"owners_count":21117757,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["hmr","hot-reload","javascript","json","loader","sass","sass-vars","scss","variables","webpack","webpack-loader"],"created_at":"2024-12-22T19:16:53.118Z","updated_at":"2025-04-12T04:55:04.224Z","avatar_url":"https://github.com/dsc8x.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eSass Vars Loader\u003c/h1\u003e\n\u003ch3 align=\"center\"\u003eImport Sass vars from Webpack config or from JS/JSON files\u003c/h3\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca target=\"_blank\" href=\"https://travis-ci.org/epegzz/sass-vars-loader\"\u003e\n    \u003cimg alt=\"Travis\" src=\"https://img.shields.io/travis/epegzz/sass-vars-loader.svg?style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca target=\"_blank\" href=\"https://codeclimate.com/github/epegzz/sass-vars-loader/maintainability\"\u003e\n    \u003cimg alt=\"Maintainability\" src=\"https://img.shields.io/codeclimate/maintainability/epegzz/sass-vars-loader.svg?style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca target=\"_blank\" href=\"https://codecov.io/gh/epegzz/sass-vars-loader\"\u003e\n    \u003cimg alt=\"Codecov\" src=\"https://img.shields.io/codecov/c/github/epegzz/sass-vars-loader.svg?style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca target=\"_blank\" href=\"https://www.npmjs.com/package/@epegzz/sass-vars-loader\"\u003e\n    \u003cimg alt=\"npm version\" src=\"https://img.shields.io/npm/v/@epegzz/sass-vars-loader.svg?style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca target=\"_blank\" href=\"https://www.npmjs.com/package/@epegzz/sass-vars-loader\"\u003e\n    \u003cimg alt=\"npm installs\" src=\"https://img.shields.io/npm/dm/@epegzz/sass-vars-loader.svg?style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca target=\"_blank\" href=\"https://david-dm.org/epegzz/sass-vars-loader\"\u003e\n    \u003cimg alt=\"dependencies\" src=\"https://img.shields.io/david/epegzz/sass-vars-loader.svg?style=flat-square\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\n\n\n\n##### This loader allows you to use Sass variables defined in:\n\n\u003cli\u003e✅ JSON Files\u003c/li\u003e\n\u003cli\u003e✅ JavaScript Files\u003c/li\u003e\n\u003cli\u003e✅ Inlined in Webpack Config\u003c/li\u003e\n\n\n\n##### Supports both syntax types:\n\n\u003cli\u003e✅ SASS Syntax\u003c/li\u003e\n\u003cli\u003e✅ SCSS Syntax\u003c/li\u003e\n\n\n\n##### Supports hot reload:\n\n\u003cli\u003e✅ HMR Enabled\u003c/li\u003e\n\n\u003cbr/\u003e\n\n## Install\n\nusing npm\n```sh\nnpm install @epegzz/sass-vars-loader --save-dev\n```\nusing yarn\n```sh\nyarn add @epegzz/sass-vars-loader --dev\n```\n\n\n## Usage\n\nLook at the [Example Webpack Config File](./example/webpack.config.js) to see how to use this\nloader in conjunction with [style-loader](https://github.com/webpack-contrib/style-loader) and\n[css-loader](https://github.com/webpack-contrib/css-loader)\n\n### Option 1: Inline Sass vars in the webpack config\n\n```scss\n// styles.css:\n\n.some-class {\n  background: $greenFromWebpackConfig;\n}\n```\n\n```js\n// webpack.config.js\n\nvar path = require('path');\n\nmodule.exports = {\n  entry: './src/index.js',\n  module: {\n    rules: [{\n      test: /\\.scss$/,\n      use: [\n        // Inserts all imported styles into the html document\n        { loader: \"style-loader\" },\n\n        // Translates CSS into CommonJS\n        { loader: \"css-loader\" },\n\n        // Compiles Sass to CSS\n        { loader: \"sass-loader\", options: { includePaths: [\"app/styles.scss\"] } },\n\n        // Reads Sass vars from files or inlined in the options property\n        { loader: \"@epegzz/sass-vars-loader\", options: {\n          syntax: 'scss',\n          // Option 1) Specify vars here\n          vars: {\n            greenFromWebpackConfig: '#0f0'\n          }\n        }\n      }]\n    }]\n  },\n  output: {\n    filename: 'bundle.js',\n    path: path.resolve(__dirname, 'dist')\n  }\n};\n```\n\n### Option 2: Load Sass vars from JSON file\n\n```js\n// config/sassVars.json\n\n{\n  \"purpleFromJSON\": \"purple\"\n}\n```\n\n```scss\n// styles.css:\n\n.some-class {\n  background: $purpleFromJSON;\n}\n```\n\n```js\n// webpack.config.js\n\nvar path = require('path');\n\nmodule.exports = {\n  entry: './src/index.js',\n  module: {\n    rules: [{\n      test: /\\.scss$/,\n      use: [\n        // Inserts all imported styles into the html document\n        { loader: \"style-loader\" },\n\n        // Translates CSS into CommonJS\n        { loader: \"css-loader\" },\n\n        // Compiles Sass to CSS\n        { loader: \"sass-loader\", options: { includePaths: [\"app/styles.scss\"] } },\n\n        // Reads Sass vars from files or inlined in the options property\n        { loader: \"@epegzz/sass-vars-loader\", options: {\n          syntax: 'scss',\n          files: [\n            // Option 2) Load vars from JSON file\n            path.resolve(__dirname, 'config/sassVars.json')\n          ]\n        }\n      }]\n    }]\n  },\n  output: {\n    filename: 'bundle.js',\n    path: path.resolve(__dirname, 'dist')\n  }\n};\n```\n\n\n### Option 3: Load Sass vars from JavaScript file\n\n```js\n// config/sassVars.js\n\nmodule.exports = {\n  blueFromJavaScript: 'blue'\n};\n```\n\n```scss\n// styles.css:\n\n.some-class {\n  background: $blueFromJavaScript;\n}\n```\n\n```js\n// webpack.config.js\n\nvar path = require('path');\n\nmodule.exports = {\n  entry: './src/index.js',\n  module: {\n    rules: [{\n      test: /\\.scss$/,\n      use: [\n        // Inserts all imported styles into the html document\n        { loader: \"style-loader\" },\n\n        // Translates CSS into CommonJS\n        { loader: \"css-loader\" },\n\n        // Compiles Sass to CSS\n        { loader: \"sass-loader\", options: { includePaths: [\"app/styles.scss\"] } },\n\n        // Reads Sass vars from files or inlined in the options property\n        { loader: \"@epegzz/sass-vars-loader\", options: {\n          syntax: 'scss',\n          files: [\n            // Option 3) Load vars from JavaScript file\n            path.resolve(__dirname, 'config/sassVars.js')\n          ]\n        }\n      }]\n    }]\n  },\n  output: {\n    filename: 'bundle.js',\n    path: path.resolve(__dirname, 'dist')\n  }\n};\n```\n\n\n### Pro Tip: Using objects as Sass vars!\n\nUse [map_get](http://sass-lang.com/documentation/Sass/Script/Functions.html#map_get-instance_method)\nin order to use objects as Sass vars:\n\n```js\n// config/sassVars.js\n\nmodule.exports = {\n  lightTheme: {\n    background: 'white',\n    color: 'black'\n  },\n  darkTheme: {\n    background: 'black',\n    color: 'gray'\n  }\n};\n```\n\n```scss\n// styles.css:\n\n$theme: $lightTheme;\n\n.some-class {\n  background: map_get($theme, background);\n  color: map_get($theme, color);\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsc8x%2Fsass-vars-loader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdsc8x%2Fsass-vars-loader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsc8x%2Fsass-vars-loader/lists"}