{"_id":"yproject","_rev":"14-ddeb20e0230824c8c8edb422780e4f6d","name":"yproject","description":"Command line tool to simplify YUI3-based projects & librairies development","dist-tags":{"latest":"2.0.0"},"versions":{"1.0.0":{"name":"yproject","version":"1.0.0","description":"Command line tool to simplify YUI3-based projects & librairies development","author":{"name":"Eric Abouaf","email":"eric.abouaf@gmail.com"},"bugs":{"web":"http://github.com/neyric/yproject/issues"},"os":["darwin","linux"],"contributors":[{"name":"Eric Abouaf","email":"eric.abouaf@gmail.com","url":"http://neyric.com"}],"engines":{"node":">=0.2.0"},"bin":{"yproject":"./bin/yproject.js"},"dependencies":{"ejs":">=0.2.0","xml2js":">=0.1.5"},"licenses":[],"repository":{"type":"git","url":"http://github.com/neyric/yproject.git"},"_id":"yproject@1.0.0","_nodeSupported":true,"_npmVersion":"0.2.8-1","_nodeVersion":"v0.2.5","dist":{"tarball":"https://registry.npmjs.org/yproject/-/yproject-1.0.0.tgz","shasum":"4d07ec6151dfaae99f7e165b2eb604c152380b3d","integrity":"sha512-v2ZXKSTaiLjbroWiVPpAh3jgd4dMDneediEq8+ZXUTe6jE4J77oaTQ+M253cZUoPsrI6ZILOCo6vOBr3eyNQUw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGzX+NcQ7eg2VNFMOGW5Yai71wWQlCuW9aTOIsj1v27jAiEA60H6m1Fib35fW0mWcplJWjg7e0eznDLTkijcVSNEdMA="}]}},"1.1.0":{"name":"yproject","version":"1.1.0","description":"Command line tool to simplify YUI3-based projects & librairies development","author":{"name":"Eric Abouaf","email":"eric.abouaf@gmail.com"},"bugs":{"web":"http://github.com/neyric/yproject/issues"},"os":["darwin","linux"],"contributors":[{"name":"Eric Abouaf","email":"eric.abouaf@gmail.com","url":"http://neyric.com"}],"engines":{"node":">=0.2.0"},"bin":{"yproject":"./bin/yproject.js"},"dependencies":{"ejs":">=0.2.0","xml2js":">=0.1.5"},"licenses":[],"repository":{"type":"git","url":"http://github.com/neyric/yproject.git"},"_id":"yproject@1.1.0","_nodeSupported":true,"_npmVersion":"0.2.8-1","_nodeVersion":"v0.2.5","dist":{"tarball":"https://registry.npmjs.org/yproject/-/yproject-1.1.0.tgz","shasum":"eafac87c55ed6db0b24bc5fbcfcb679e390d638f","integrity":"sha512-Gqw/cmlthE+AUa/Ead9luSUAXYCV8WmenmX1oiWlpLvFomQYgoMhTCrlNbVLbhLWH7Bua9FsDCtXa7e/rdJfsw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBPafkRGbeGjye/CmvIOD9zdZO/JFc2ZvGggjno1VUHXAiBqlzjQcCNGHAAwFP258oIM+UlPvgPp7q/Xi69L4wlvSQ=="}]}},"1.2.0":{"name":"yproject","version":"1.2.0","description":"Command line tool to simplify YUI3-based projects & librairies development","author":{"name":"Eric Abouaf","email":"eric.abouaf@gmail.com"},"bugs":{"url":"http://github.com/neyric/yproject/issues"},"os":["darwin","linux"],"contributors":[{"name":"Eric Abouaf","email":"eric.abouaf@gmail.com","url":"http://neyric.com"}],"engines":{"node":">=0.2.0"},"bin":{"yproject":"./bin/yproject.js"},"dependencies":{"ejs":">=0.2.0","xml2js":">=0.1.5"},"licenses":[],"repository":{"type":"git","url":"http://github.com/neyric/yproject.git"},"_id":"yproject@1.2.0","_engineSupported":true,"_npmVersion":"0.2.16","_nodeVersion":"v0.4.0","directories":{"lib":"./lib","bin":"./bin"},"modules":{"java/antlr-2.7.7.jar":"lib/java/antlr-2.7.7.jar","java/antlr-3.2.jar":"lib/java/antlr-3.2.jar","java/antlr-runtime-3.2.jar":"lib/java/antlr-runtime-3.2.jar","java/jargs-1.0.jar":"lib/java/jargs-1.0.jar","java/junit-4.1.jar":"lib/java/junit-4.1.jar","java/selenium-java-client-driver.jar":"lib/java/selenium-java-client-driver.jar","java/selenium-server.jar":"lib/java/selenium-server.jar","java/stringtemplate-3.2.1.jar":"lib/java/stringtemplate-3.2.1.jar","java/yuitest-coverage-report.jar":"lib/java/yuitest-coverage-report.jar","java/yuitest-coverage.jar":"lib/java/yuitest-coverage.jar","java/yuitest-selenium-driver.jar":"lib/java/yuitest-selenium-driver.jar"},"files":[""],"_defaultsLoaded":true,"dist":{"shasum":"580150993ad5b31d2b5ccf1d77f2af82aa83c52d","tarball":"https://registry.npmjs.org/yproject/-/yproject-1.2.0.tgz","integrity":"sha512-WyTJBJHrETujhW0CnJuMupDFyD3pYbgSVMFq/6P0f+qvvLNZNVSpCl1leetLD9p8QqbsvMFtAYHOEyJntJeEcA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDZfYeC7Fp/yjJjhllnWad13mOgJnlb+Q5RNttYT8SC3gIgZyvBgpB9RBkuszN8DzPvcEP/z8cDxCQMbH1+sykdN2Q="}]}},"1.3.0":{"name":"yproject","version":"1.3.0","description":"Command line tool to simplify YUI3-based projects & librairies development","author":{"name":"Eric Abouaf","email":"eric.abouaf@gmail.com"},"bugs":{"url":"http://github.com/neyric/yproject/issues"},"os":["darwin","linux"],"contributors":[{"name":"Eric Abouaf","email":"eric.abouaf@gmail.com","url":"http://neyric.com"}],"engines":{"node":">=0.4.0"},"bin":{"yproject":"./bin/yproject.js"},"dependencies":{"ejs":">=0.4.3","xml2js":">=0.1.10"},"licenses":[],"repository":{"type":"git","url":"git://github.com/neyric/yproject.git"},"_npmJsonOpts":{"file":"/Users/neyric/.npm/yproject/1.3.0/package/package.json","wscript":false,"contributors":false,"serverjs":false},"_id":"yproject@1.3.0","devDependencies":{},"_engineSupported":true,"_npmVersion":"1.0.27","_nodeVersion":"v0.4.11","_defaultsLoaded":true,"dist":{"shasum":"dfaf154bc017603fac1c0a4cd9d9fff3ae30a5f3","tarball":"https://registry.npmjs.org/yproject/-/yproject-1.3.0.tgz","integrity":"sha512-dbXee/Y4CDj5WsndS9GBcwYknzMDbhhAMESXHgSdYeE7JOHbBssWUTO0p+j7vK2sGIDNe6f5ThWmGj/rd2sdtA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIF4LdTV/VGqLR0CSQape6/TCwdRFpZWtGImwuafEjzv5AiAvqtaAsU0xxEWmmj9moXAQCiyuBnET70Aeud0K9O9tuA=="}]},"maintainers":[{"name":"neyric","email":"eric.abouaf@gmail.com"}]},"2.0.0":{"name":"yproject","version":"2.0.0","description":"Command line tool to simplify YUI3-based projects & librairies development","author":{"name":"Eric Abouaf","email":"eric.abouaf@gmail.com"},"bugs":{"url":"http://github.com/neyric/yproject/issues"},"os":["darwin","linux"],"contributors":[{"name":"Eric Abouaf","email":"eric.abouaf@gmail.com","url":"http://neyric.com"}],"engines":{"node":">=0.4.0"},"main":"lib/yproject","bin":{"yproject":"./bin/yproject.js","ymodule":"./bin/ymodule.js"},"dependencies":{"optimist":"0.3.4","ejs":">=0.4.3","colors":"0.6.0-1"},"licenses":[],"repository":{"type":"git","url":"http://github.com/neyric/yproject.git"},"readme":"# yproject\n\nyproject is a command-line utility to scaffold YUI3 projects and modules.\n\nIt contains a project template and a module template to quickly bootstrap your project enforcing best practices from the start.\n\n\n## Installation\n\n $ [sudo] npm install -g yproject\n\nOr install it as a developer :\n\n $ git clone git://github.com/neyric/yproject.git\n $ cd yproject\n $ [sudo] npm link\n\n\n## Usage\n\n### Create a new project\n\n $ yproject myproject\n \nThis will create the following structure :\n\n myproject/\n README.md\n package.json\n yuidoc.json\n src/\n common/\n myproject-loader/\n\n\n * yuidoc.json is used to generate the API documentation using yuidocjs\n * src/myproject-loader is a module which will generate a YUI3 seed file for using the YUI3 loader\n * src/common contains a simple documentation template to use with selleck\n\n### Creating a new module\n\nGo to your project directory and type :\n\n $ ymodule mymodule\n\nThis will create the following structure in src/ :\n\n mymodule/\n build.json\n README.md\n js/\n mymodule.js\n meta/\n mymodule.json\n\n\n#### Assets\n\nBy default, ymodule will also create an 'assets' folder containing a 'sam' skin.\n\nIt will also mark the module as skinnable in the meta file.\n\nTo disable the assets generation, use the --no-assets (or --no-a) option :\n\n $ ymodule mymodule --no-assets\n\n\n#### Docs\n\nBy default, ymodule will generate a 'docs' folder containing two pages for the module description and a basic example.\n\nIt will later be used by the selleck documentation rendering.\n\nTo disable the docs generation, use the --no-docs (or --no-d) option :\n\n $ ymodule mymodule --no-docs\n\n\n#### Lang (I18n, intl)\n\nBy default, ymodule will create a 'lang' folder containing a 'en' localization file.\n\nIt will also require the 'intl' module in the meta file.\n\nTo disable it, use the --no-lang (or --no-l) option :\n\n $ ymodule mymodule --no-lang\n\n\n#### Tests\n\nBy default, ymodule will create a 'tests' folder with a basic test case.\n\nTo disable it, use the --no-tests (or --no-t) option :\n\n $ ymodule mymodule --no-tests\n\n\n#### Widget\n\nBy using the --widget option (or -w), ymodule will use a widget template for the generated javascript file :\n\n $ ymodule mywidget -w\n\n\n### Updating an existing module\n\nIf you already have a working module, you can add some options to it.\n\nAssuming you have a very basic module 'mymodule', with just the js/, meta/, and build.json files :\n\n $ cd mymodule\n $ ymodule --no-docs\n\nThis command will generate assets/, tests/, and lang/ folders if they don't exist yet.\nIl will also add the missing dependencies in the meta.json file.\n\n\n\n### Default loader module\n\nA special module is created when you create a new project (ex: \"myproject-loader\"), which adds your module definitions to the YUI loader utility.\n\nThis module is auto-generated, so you won't have to touch anything in it.\n\nYou may want to edit the template/meta.js file to tweek some loader options.\n\nThis module has to be re-built everytime you add a new module to the project, or when you change a meta file description in any module.\n\n $ cd src/myproject-loader\n $ shifter\n\n\n\n## Building modules\n\n

We use shifter to build YUI modules.

\n\n

To install shifter :

\n\n```terminal\n$ [sudo] npm install -g shifter\n```\n\n

To build the 'container' module :

\n\n```terminal\n$ cd src/container\n$ shifter\n```\n\n

To build all modules at once :

\n\n```terminal\n$ cd src\n$ shifter --walk\n```\n\n## Building user guides and examples pages\n\n

We are using selleck to build the examples and user guide pages.

\n\n\n

To install selleck :

\n\n```terminal\n$ [sudo] npm install -g selleck\n```\n\n

To build all docs :

\n\n```terminal\n$ selleck --out docs\n```\n\n## Building the API documentation\n\n

The API documentation is build using YUIDocJS.

\n\n\n

To install YUIDocJS :

\n\n```terminal\n$ [sudo] npm install -g yuidocjs\n```\n\n

From the main directory, type :

\n\n```terminal\n$ yuidoc\n```\n\n

It should generate the doc in the api/ folder.

\n\n\n## How to run the tests\n\n

Tests are executed with Yeti.

\n\n\n

To install Yeti :

\n\n```terminal\n$ [sudo] npm install -g yeti\n```\n\n

From the main directory, type :

\n\n```terminal\n$ yeti src/*/tests/unit/*.html\n```\n\n

This command creates a one shot server and return you an adress which you have to connect a browser in order to run the tests. You can also invoke the same command with \"--server\" in order to have a persistent server

\n\n```terminal\n$ yeti src/*/tests/unit/*.html --server\n```\n\n

Testing with coverage :

\n\n```terminal\n$ yeti src/*/tests/unit/*.html --server --query 'filter=coverage'\n```\n\n\n## Full example\n\nSee example.sh to see a complete example\n\n","_id":"yproject@2.0.0","dist":{"shasum":"e02fee3bd0711046ccfde22acaa1f4163631927a","tarball":"https://registry.npmjs.org/yproject/-/yproject-2.0.0.tgz","integrity":"sha512-vw86reygdD7KXJM8R/jSThqRnwkninN+UJJF5aIXAno9iL2TE3nurklbmoHGjN8rgCZrbYLjFMdF+Rctb9RgCg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCVwOlEpdCgcjsI7ZwdIp6KoWXGH4jIt9i0NYmn80wYPAIhANXAaVaSz1bZUMyEWhl4KEbyExyAkm5hzi6/kcPj+GfQ"}]},"_npmVersion":"1.1.63","_npmUser":{"name":"neyric","email":"eric.abouaf@gmail.com"},"maintainers":[{"name":"neyric","email":"eric.abouaf@gmail.com"}]}},"maintainers":[{"name":"neyric","email":"eric.abouaf@gmail.com"}],"author":{"name":"Eric Abouaf","email":"eric.abouaf@gmail.com"},"repository":{"type":"git","url":"http://github.com/neyric/yproject.git"},"time":{"modified":"2022-06-29T08:14:53.649Z","created":"2011-02-18T17:35:27.709Z","1.0.0":"2011-02-18T17:35:27.709Z","1.1.0":"2011-02-18T17:35:27.709Z","1.2.0":"2011-02-18T17:35:27.709Z","1.3.0":"2011-09-23T22:05:55.161Z","2.0.0":"2012-12-02T15:16:39.415Z"}}