flyntwp / generator-flynt

A Yeoman generator to create Flynt Components

Flynt Yeoman Generator (generator-flynt)

A Yeoman generator for Flynt

⚠️ DEPRECATED. This repository is no longer in active development. For the latest version of Flynt please use the new Flynt repository. ⚠️

Table of Contents

• Flynt Yeoman Generator (generator-flynt)
  • Table of Contents
  • Install
  • Usage
  • Maintainers
  • Contribute
  • License

Install

The node version used should be ^10. If you use a node version manager (e.g. nave), use npm to install globally.

First install Yeoman:

$ npm i -g yo

Install the generator:

$ npm i -g @flyntwp/generator-flynt

Otherwise you can use yarn as well:

$ yarn global add @flyntwp/generator-flynt

Usage

Run yo @flyntwp/flynt to start the generator. You can select Components.

Maintainers

This project is maintained by bleech.

The main people in charge of the repo are:

• Dominik Tränklein
• Doğa Gürdal
• Markus Müller

Contribute

To contribute, please use GitHub issues. Please also take a moment to read the Contributing Guidelines and Code of Conduct.

If you are a developer and would like to submit a pull request, do the following:

1. Fork the project and clone it.
2. Run npm install inside the cloned folder.
3. Run npm link to link the local installation for development purposes. (Run npm unlink to undo this step.)
4. In any folder run yo @flyntwp/flynt to run your local development version and test your changes.
5. Send a pull request from your fork to the main repo's master branch.

If editing the README, please conform to the standard-readme specification.

License

MIT © bleech

generator-flynt's Issues

Update lookup variables inside templates

Problem
The lookup variables are still written in kebab-case, while we moved to camelCase in the official flynt-theme.

See here
https://github.com/flyntwp/generator-flynt/blob/master/generators/component/templates/custom/style.styl#L1

$global-layout-scale should actually be $globalLayoutScale. Same with the other variables.

update npm version

Please release a new version on npm so that the latest variable name changes are in there.

For example $globalRuptureScale is still called $globalLayoutScale in the latest published version.

Add a new true/false selection for additional files

Right now I can't decide if I want to generate additional files like the README or Component screenshots too. If I only want to generate one single file (stylus.styl) for example, I can't do so without generating additional content.

README.md

Please adjust the repo's README.md to match standard-readme format.

See https://github.com/RichardLitt/standard-readme

Add updated readme template

I want dis https://github.com/bleech/readme-template automagically generated for components. Would be amazeballs.

Add Container Padding variable to template

Problem
Right now we don't have a variable for the outter container paddings used inside the Jeet center().

See here
https://github.com/flyntwp/generator-flynt/blob/master/generators/component/templates/custom/style.styl

We need to add

$gutterWidth = lookup('$globalLayoutGutterWidth') || 2
$containerPadding = lookup('$globalLayoutContainerPadding') || 15px

Error when selecting either option

Hello. Managed to install the generator, it starts when I use yo @flyntwp/generator, but whenever I select an option, the following error occurs. Tried running it in the theme folder, in the Components folder and in a newly created folder for a Component.

events.js:174
      throw er; // Unhandled 'error' event
      ^
Error: ENOENT: no such file or directory, scandir '{myfolder}\themes\flynt\theme\/Components'
    at Object.readdirSync (fs.js:786:3)
    at module.exports._promptComponentFile (\AppData\Local\Yarn\Data\global\node_modules\@flyntwp\generator-flynt\generators\component\index.js:77:8)
    at prompt.then.answers (AppData\Local\Yarn\Data\global\node_modules\@flyntwp\generator-flynt\generators\component\index.js:43:21)
    at process._tickCallback (internal/process/next_tick.js:68:7)
Emitted 'error' event at:
    at Immediate.setImmediate (\AppData\Local\Yarn\Data\global\node_modules\yeoman-generator\lib\index.js:450:18)
    at runCallback (timers.js:705:18)
    at tryOnImmediate (timers.js:676:5)
    at processImmediate (timers.js:658:5)

Cheers !

Templates/Components/functions.php - Add padding lines

Add whitespaced padding lines for the functions.php so the return $data; line is padded by a whitespaced line on top.