{"id":20538034,"url":"https://github.com/yoannmoinet/generator-libstart","last_synced_at":"2025-10-04T13:44:26.760Z","repository":{"id":41819607,"uuid":"40095192","full_name":"yoannmoinet/generator-libstart","owner":"yoannmoinet","description":":gift: Yeoman generator to start your UMD library.","archived":false,"fork":false,"pushed_at":"2015-09-20T22:11:06.000Z","size":175,"stargazers_count":1,"open_issues_count":3,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-16T19:05:23.370Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://yoannmoinet.github.io/generator-libstart/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yoannmoinet.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-02T22:44:31.000Z","updated_at":"2015-11-22T22:29:34.000Z","dependencies_parsed_at":"2022-09-03T17:00:17.060Z","dependency_job_id":null,"html_url":"https://github.com/yoannmoinet/generator-libstart","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoannmoinet%2Fgenerator-libstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoannmoinet%2Fgenerator-libstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoannmoinet%2Fgenerator-libstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoannmoinet%2Fgenerator-libstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yoannmoinet","download_url":"https://codeload.github.com/yoannmoinet/generator-libstart/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242144494,"owners_count":20078966,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T00:43:56.284Z","updated_at":"2025-10-04T13:44:21.723Z","avatar_url":"https://github.com/yoannmoinet.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LibStart\n\n\u003e [Yeoman](http://yeoman.io) generator to start your UMD library.\n\n[![npm version](https://img.shields.io/npm/v/generator-libstart.svg?style=flat-squared)](http://badge.fury.io/js/generator-libstart)\n[![Build Status](https://img.shields.io/travis/yoannmoinet/generator-libstart.svg?style=flat-squared)](https://travis-ci.org/yoannmoinet/generator-libstart)\n[![Join the chat at https://gitter.im/yoannmoinet/generator-libstart](https://img.shields.io/badge/gitter-join%20chat-brightgreen.svg?style=flat-squared)](https://gitter.im/yoannmoinet/generator-libstart?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n----\n\n## Getting Started\nIf you'd like to get to know Yeoman better check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).\n\n----\n\n### Overview\nThis generator will create a basic scaffolding of a generic [UMD](https://github.com/umdjs/umd) library.\n\nIt will come with :\n- changelog generator ([conventional-changelog](https://github.com/ajoslin/conventional-changelog))\n- linting ([eslint](http://eslint.org/))\n- formatting ([jscs](http://jscs.info/))\n- testing ([mocha](http://mochajs.org/) + [expect.js](https://github.com/Automattic/expect.js))\n- building ([uglify-js](https://github.com/mishoo/UglifyJS2) + [umd](https://github.com/ForbesLindesay/umd))\n\n----\n\n### Install\nTo install generator-libstart from npm, run:\n\n```bash\nnpm install -g yo generator-libstart\n```\n\nFinally, initiate the generator:\n\n```bash\nyo libstart\n```\n\n----\n\n### Usage\n\nTo generate your new library simply run :\n\n```bash\nyo libstart \u003cname of your creation\u003e\n```\n\nAnswer to some questions and you're good to go.\n\nYou'll be able to reserve your library's name into npm's registry if you whish to.\n\nIn your new library, you'll have some scripts available to automate your development.\n\n#### Npm Scripts\n##### `npm preversion` (auto)\n\u003e It runs `npm build`.\n\n##### `npm postversion` (auto)\n\u003e It runs `bowerSync` and `changelog`.\n\n##### `npm pretest` (auto)\n\u003e It runs `build`.\n\n##### `npm test` (manual)\n\u003e It launches tests with mocha.\n\n##### `npm postest` (auto)\n\u003e It runs `format` and `lint`.\n\n#### Custom Scripts\nThey are all run by the previous npm scripts but you can run them at your convenience.\n\n##### `npm run prebuild` (manual)\n\u003e It runs `format` and `lint`.\n\n##### `npm run build` (manual)\n\u003e It runs `umd` and `uglify`.\n\n##### `npm run format`\n\u003e Test the formatting with **JSCS**\n\n##### `npm run lint`\n\u003e Lint with **ESLint**\n\n##### `npm run umd`\n\u003e It packages your library with [umd](https://www.npmjs.com/package/umd)\n\n##### `npm run changelog`\n\u003e Generate a changelog for your library based on your commits if you've followed one of the supported [convention](https://github.com/ajoslin/conventional-changelog/tree/master/conventions),\n\u003e and will commit the changes automatically.\n\n##### `npm run bowerSync`\n\u003e It synchronizes bower.json's version with package.json's,\n\u003e and will commit the changes automatically.\n\n##### `npm run uglify`\n\u003e It uglifies your library.\n\n----\n\n### Structure\n\n```javascript\nlibrary\n├ .eslintrc           // Basic ESLint config\n├ .editorconfig       // Basic Editor config\n├ .jscsrc             // Basic JSCS config\n├ README.md\n├ LICENSE\n├ package.json\n├ bower.json\n│\n└─── bin               // Helpers for npm scripts\n|    ├ changelog.js    // Is run with 'npm run changelog'\n|    └ bowerSync.js    // Is run with 'npm postversion'\n|\n└─── src\n|    └ lib.js          // Main file\n|\n└─── test\n     └ lib.spec.js     // Mocha tests\n```\n\n----\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoannmoinet%2Fgenerator-libstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyoannmoinet%2Fgenerator-libstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoannmoinet%2Fgenerator-libstart/lists"}