npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cssify-to-json-class-index

v0.0.4

Published

CSS pseudo-rules parser, to be used as a transform for Browserify (w/ .class grouping)

Downloads

10

Readme

CSSifyToJsonClassIndex (cssify-to-json-class-index)

This transform implements a way to evaluate some sort of "custom CSS rules" in the .js files, to be used by a template compiler to generate a *.css file defining "styling behaviors" through a set of composed CSS rules. It allows you, for any Vanilla Javascript component, to declare directly in the .js file, the "styling behavior" that component uses.

It is a reverse indexed version of cssify-to-json.

How it works :

When bundling CommonJS file structure with Browserify, this transform looks for "@CSSify" rules declared as commentaries in the *.js files.

Found rules are grouped in a newly created JSON file in a path relative to the bundle's root path.

Example :

Put that comment in some *.js file :

\*
 * @CSSify exports: .aClassName stdTextColor/bevel/roundedCorner/etc.
 */

The transform will generate a file named jsComponents_css_class-compile.json.html in the <%=pathToProject%>/css/ folder, with the following content :

{
	".aClassName": "ridge/bigRoundedCorner/border",
	".anotherClassName": "spanHandle/bigRoundedCorner/flatLightButton_F",
	".aThirdClassName": "border/roundedCorner/padding/ridge",
	".aComplexClassName": "pattern/bigPadding/flexBoxColumn/roundedCorner/border/shadow/foregroundElem",
	".aClassNameDefiningFlexElem": "flexBoxRow/flexCenter",
	".text_input": "ridge",
	".submit_button_elem": "pattern/groove/roundedCorner/buttonText",
	etc.
}

And will continue to associate CSS class names with "behavior" pseudo-rules as it finds them in other *.js files.

##Basic usage

example gruntfile.js with grunt-browserify

module.exports = function (grunt, options) {

	//...[here you define the variables you use : pathToProject, currentProject... with the "grunt" mechanism of your choice]
	
	grunt.initConfig({
		browserify : {
			release: {
				files: {
					'<%=pathToProject%>js/<%=currentProject%>.dist.js': ['<%=pathToProject%>src/index.js']
				},
				options: {
					transform: [['cssify-to-json-class-index', {pathToProject : options.pathToProject}]]
				}
			}
		}
	}
}

##Notes

I'm using Spip as a serverside template compiler (php), to parse the JSON, aggregate other technologies, generate and cache the CSS files

Please let me know if you need adaptating this transform to another compiler, or if you wrote such a fork.

####A CSS Example isn't really needed there :

The behaviors are defined as variables in a template file, and concatenated into .class selector rules