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

grunt-init-yui

v0.1.1

Published

Create a YUI module with grunt-init.

Downloads

3

Readme

grunt-init-yui Build Status

Create a YUI module with grunt-init, including YUITest unit tests and Istanbul code coverage.

Installation

Install grunt-init-yui globally via npm.

npm -g install grunt-init-yui

Usage

At the command-line, cd into an empty directory, run this command and follow the prompts.

grunt-init-yui

If a YUI-based project does not exist yet, it will create one. An initialized module is placed under src/{moduleName} in the current directory.

Note that this template will generate files in the current directory,so be sure to change to a new directory first if you don't want to overwrite existing files.

Options

  --project       Only initialize a project, not a module.
  --gallery       The module initialized will live in the gallery.

  --no-color      Disables color output.
  --no-write      Disables writing files (dry run).
  -f, --force     Ignore warnings. Caveat emptor.
  -v, --version   Print version and exit.

Directory Structure

When initializing a module or project, it is helpful (but by no means required) to already have a Git repo initialized:

mkdir project
cd project
git init .

Project Root

project/
 ├── BUILD.md
 ├── Gruntfile.js
 ├── LICENSE-MIT
 ├── README.md
 └── package.json

JS Module

This is the default module type, and is by far the most common across the core library.

 project/
 └─┬ src/
   └─┬ js-module/
     ├── HISTORY.md
     ├── README.md
     ├── build.json
     ├─┬ docs/
     │ ├── component.json
     │ └── index.mustache
     ├─┬ js/
     │ └── js-module.js
     ├─┬ meta/
     │ └── js-module.json
     └─┬ tests/
       └─┬ unit/
         ├── index.html
         └─┬ assets/
           └── js-module-test.js

CSS Module

A CSS module contains a css directory instead of js, and is otherwise remarkably similar to a JS module.

 project/
 └─┬ src/
   └─┬ css-module/
     ├── HISTORY.md
     ├── README.md
     ├── build.json
     ├─┬ css/
     │ └── css-module.css
     ├─┬ docs/
     │ ├── component.json
     │ └── index.mustache
     ├─┬ meta/
     │ └── css-module.json
     └─┬ tests/
       └─┬ unit/
         └── index.html

Widget Module

The output of the widget type is identical to js, with the addition of an assets folder containing core and skin CSS files. The metadata is also modified to require widget and sets the skinnable property to true.

 project/
 └─┬ src/
   └─┬ widget-module/
     ├── HISTORY.md
     ├── README.md
     ├── build.json
     ├─┬ assets/
     │ └─┬ widget-module/
     │   ├── widget-module-core.css
     │   └─┬ skins/
     │     ├─┬ night/
     │     │ └── widget-module-skin.css
     │     └─┬ sam/
     │       └── widget-module-skin.css
     ├─┬ docs/
     │ ├── component.json
     │ └── index.mustache
     ├─┬ js/
     │ └── widget-module.js
     ├─┬ meta/
     │ └── widget-module.json
     └─┬ tests/
       └─┬ unit/
         ├── index.html
         └─┬ assets/
           └── widget-module-test.js