https://github.com/cheesegrinder/stencil-sass-alias

Small plugin made for stencilJS to have alias in your sass file
https://github.com/cheesegrinder/stencil-sass-alias

alias plugin sass scss stencil

Last synced: 8 days ago
JSON representation

Small plugin made for stencilJS to have alias in your sass file

• Host: GitHub
• URL: https://github.com/cheesegrinder/stencil-sass-alias
• Owner: CheeseGrinder
• License: mit
• Created: 2024-06-21T08:27:07.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-24T17:35:07.000Z (about 2 months ago)
• Last Synced: 2024-10-29T01:37:12.992Z (18 days ago)
• Topics: alias, plugin, sass, scss, stencil
• Language: TypeScript
• Homepage:
• Size: 68.4 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Audit: audit-ci.json
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  

    

  





  Stencil Sass Alias





A plugin for [StencilJS][stencil-site] to add aliasied path in SASS and SCSS files





  

    

  

  

    

  



---------

### Install

```bash

npm install @cheese-grinder/stencil-sass-alias --save-dev

```

### Usage

```ts

// stencil.config.ts

import { sassAlias } from '@cheese-grinder/stencil-sass-alias';

import { Config } from '@stencil/core';

import { sass } from '@stencil/sass';

export const config: Config = {

  plugins: [

    sass({

      importer: [

        sassAlias()

      ]

    })

  ]

};

```

### Customization

The plugin takes one argument, which is a object with the following properties.

| property | default | optional |

| -------- | :-----: | :------: |

| path     | `src`   | `true`   |

| alias    | `@scss` | `true`   |

### Contributing

Thanks for your interest in contributing!

Please take a moment to read up on our guidelines for [contributing][contributing].

Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.

[stencil-site]: https://stenciljs.com/

[contributing]: https://github.com/CheeseGrinder/stencil-sass-alias/blob/main/CONTRIBUTING.md

[code-of-conduct]: https://github.com/CheeseGrinder/stencil-sass-alias/blob/main/CODE_OF_CONDUCT.md