Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@pro-vision/pv-stylemark

Package Overview
Dependencies
Maintainers
6
Versions
37
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@pro-vision/pv-stylemark

CLI for zero configuration stylemark-lsg-toolchain setup

  • 3.0.10
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.2K
increased by1.12%
Maintainers
6
Weekly downloads
 
Created
Source

pv-stylemark

CLI for zero configuration stylemark-lsg-toolchain-setup.

Installation

npm i @pro-vision/pv-stylemark -D

Usage

Command Line Interface

Installing this package gives you the CLI pv-stylemark. It can be used with the parameters dev and prod.

dev: Assembles all found hbs files and generates clickdummy (components/pages) and Stylemark - Living Styleguide. Starts watches all involved files.

prod: Assembles all found hbs files and generates clickdummy (components/pages) and Stylemark - Living Styleguide and writes all to your target folder.

Webpack Plugin

pv-stylemark also provides a Webpack-Plugin, which can also be used to render the LSG.

Example:
// webpack.config.module.js
const { PvStylemarkPlugin } = require("@pro-vision/pv-stylemark");


module.exports = {
  //...
  plugins: [
    new PvStylemarkPlugin()
  ]
  //...
};

Configuration

Basic Configuration

Basic Configuration for both, cli and webpack-plugin, can be done in a pv.config.js file in the npm project root-folder. Possible configuration values are:

keytypedefaultusage
destPathstring'target'defines where to put bundled files
cdTemplatesSrcstring'src/templates/'defines homefolder of clickdummy-templates (glob: [cdTemplatesSrc]**/*.hbs)
lsgTemplatesSrcstring'src/styleguide/templates/'defines homefolder of lsg-templates (glob: [lsgTemplatesSrc]**/*.hbs)
componentsSrcstring'src/components/'defines homefolder of components (glob: [componentsSrc]**/*.hbs)
cdPagesSrcstring'src/pages/'defines homefolder of clickdummy-pages (glob: [cdPagesSrc]**/*.hbs)
hbsHelperSrcstring'helpers/handlebarsHelper/'defines homefolder of additional handlebars-helpers (glob: [hbsHelperSrc]*.js)
lsgAssetsSrcstring'src/assets/'defines homefolder of dummy assets used in lsg and clickdummy (glob: [lsgAssetsSrc]**/*.js)
lsgIndexstring'src/styleguide/index.html'defines path to styleguide landing page html file
lsgConfigPathstring'config/config.stylemark.yaml'defines path to lsg config file (which is required)
Example:
// pv.config.js
module.exports = {
  destPath: 'dist',
  cdTemplatesSrc: 'src/clickdummy/templates/',
  lsgTemplatesSrc: 'src/lsg/templates/',
  cdPagesSrc: 'src/clickdummy/pages/',
  hbsHelperSrc: 'helper/handlebarsHelper/',
  lsgAssetsSrc: 'src/lsg/assets/',
  lsgConfigPath: 'config.stylemark.yaml',
};

FAQs

Package last updated on 06 May 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc