Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/electric-eloquence/fp-less
Less extension for Fepper
https://github.com/electric-eloquence/fp-less
fepper less
Last synced: about 2 months ago
JSON representation
Less extension for Fepper
- Host: GitHub
- URL: https://github.com/electric-eloquence/fp-less
- Owner: electric-eloquence
- License: mit
- Created: 2016-06-27T15:12:22.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-11-24T14:20:11.000Z (about 3 years ago)
- Last Synced: 2024-11-21T22:21:16.187Z (2 months ago)
- Topics: fepper, less
- Language: JavaScript
- Homepage: https://fepper.io/
- Size: 160 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Less extension for Fepper
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![Linux Build Status][linux-image]][linux-url]
[![Mac Build Status][mac-image]][mac-url]
[![Windows Build Status][windows-image]][windows-url]
[![Coverage Status][coveralls-image]][coveralls-url]
[![License][license-image]][license-url]
### Install
```shell
cd extend
npm install --save-dev fp-less
```
### Use
Add these tasks to `extend/custom.js`:
* Under gulp task `'custom:frontend-copy'`
* `'less:frontend-copy'`
* Under gulp task `'custom:once'`
* `'less:once'`
* Under gulp task `'custom:watch'`
* `'less:watch'`
On the command line:
```shell
fp less[:subtask]
```
Create a `source/_styles/src/less` directory and put all Less code there.
This extension will read one directory deep for files with a `.less` extension.
Partials must be nested deeper. Less code will be preprocessed into CSS and
built into the `paths.source.cssBld` directory as declared in
`patternlab-config.json`.
This extension defaults toward the printing of line comments for debugging
purposes. Doing so provides an unambiguous indication that the CSS was
preprocessed and that direct edits to the CSS should be avoided. If a project
decision is made to style with Less, it would be a good idea to have version
control ignore CSS builds in the `source` directory. This would avoid committing
line comments, which could otherwise lead to a morass of conflicts.
Another debugging alternative is writing CSS sourcemaps. (However, this will not
work if line comments are enabled.) Add the following to your `pref.yml` file:
```yaml
less:
dumpLineNumbers: false
sourceMap: true
```
To write sourcemaps inline, configure as follows:
```yaml
less:
dumpLineNumbers: false
sourceMap:
sourceMapFileInline: true
```
### Tasks
#### `'less'`
* Builds Less into CSS.
* Overwrites CSS whether or not it has direct edits.
* Respects the `less.dumpLineNumbers` setting in `pref.yml`.
* If `less.dumpLineNumbers` is not set, will default to printing line comments.
#### `'less:frontend-copy'`
* Usually under gulp task `'custom:frontend-copy'`.
* Builds Less without line comments
* The `frontend-copy` task then copies the CSS to the backend.
* Ignores any `less.dumpLineNumbers` setting in `pref.yml`.
#### `'less:no-comment'`
* Same as `'less'` and `'less:once'` but without line comments.
* Ignores any `less.dumpLineNumbers` setting in `pref.yml`.
#### `'less:once'`
* Usually under gulp task `'custom:once'`.
* Same as `'less'`.
#### `'less:watch'`
* Usually under gulp task `'custom:watch'`.
* Watches the `source/_styles/src/less` directory for file modifications.
* Triggers `less` and overwrites CSS whether or not it has direct edits.
#### `'less:watch-no-comment'`
* Usually under gulp task `'custom:watch'`.
* Watches the `source/_styles/src/less` directory for file modifications.
* Triggers `less:no-comment` and overwrites CSS whether or not it has direct
edits.
[snyk-image]: https://snyk.io/test/github/electric-eloquence/fp-less/master/badge.svg
[snyk-url]: https://snyk.io/test/github/electric-eloquence/fp-less/master
[linux-image]: https://github.com/electric-eloquence/fp-less/workflows/Linux%20build/badge.svg?branch=master
[linux-url]: https://github.com/electric-eloquence/fp-less/actions?query=workflow%3A"Linux+build"
[mac-image]: https://github.com/electric-eloquence/fp-less/workflows/Mac%20build/badge.svg?branch=master
[mac-url]: https://github.com/electric-eloquence/fp-less/actions?query=workflow%3A"Mac+build"
[windows-image]: https://github.com/electric-eloquence/fp-less/workflows/Windows%20build/badge.svg?branch=master
[windows-url]: https://github.com/electric-eloquence/fp-less/actions?query=workflow%3A"Windows+build"
[coveralls-image]: https://img.shields.io/coveralls/electric-eloquence/fp-less/master.svg
[coveralls-url]: https://coveralls.io/r/electric-eloquence/fp-less
[license-image]: https://img.shields.io/github/license/electric-eloquence/fp-less.svg
[license-url]: https://raw.githubusercontent.com/electric-eloquence/fp-less/master/LICENSE