{"id":19973787,"url":"https://github.com/dojo/cli-create-widget","last_synced_at":"2025-05-04T02:32:11.580Z","repository":{"id":23998778,"uuid":"100355842","full_name":"dojo/cli-create-widget","owner":"dojo","description":"Dojo - cli command for creating widgets boilerplate.","archived":false,"fork":false,"pushed_at":"2022-12-02T02:47:15.000Z","size":1482,"stargazers_count":1,"open_issues_count":5,"forks_count":10,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-04-17T18:47:15.459Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dojo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-15T08:22:50.000Z","updated_at":"2023-07-23T06:04:02.000Z","dependencies_parsed_at":"2023-01-14T00:12:17.968Z","dependency_job_id":null,"html_url":"https://github.com/dojo/cli-create-widget","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojo%2Fcli-create-widget","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojo%2Fcli-create-widget/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojo%2Fcli-create-widget/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojo%2Fcli-create-widget/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dojo","download_url":"https://codeload.github.com/dojo/cli-create-widget/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252279012,"owners_count":21722811,"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-13T03:12:52.869Z","updated_at":"2025-05-04T02:32:11.071Z","avatar_url":"https://github.com/dojo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cli-create-widget\n\n[![Build Status](https://travis-ci.org/dojo/cli-create-widget.svg?branch=master)](https://travis-ci.org/dojo/cli-create-widget)\n\u003c!-- [![Build status](https://ci.appveyor.com/api/projects/status/ap88vuv8xsuelowm/branch/master?svg=true)](https://ci.appveyor.com/project/Dojo/cli-create-widget/branch/master) --\u003e\n[![codecov](https://codecov.io/gh/dojo/cli-create-widget/branch/master/graph/badge.svg)](https://codecov.io/gh/dojo/cli-create-widget)\n[![npm version](https://badge.fury.io/js/%40dojo%2Fcli-create-widget.svg)](https://badge.fury.io/js/%40dojo%2Fcli-create-widget)\n\nA [Dojo CLI](https://github.com/dojo/cli) command that creates a Dojo 2 widget template with an optional custom element descriptor.\n\n- [Usage](#usage)\n- [Features](#features)\n- [How do I contribute?](#how-do-i-contribute)\n  - [Code Style](#code-style)\n  - [Installation](#installation)\n  - [Testing](#testing)\n- [Licensing information](#licensing-information)\n\n## Usage\n\nTo use `@dojo/cli-create-widget`, install the project globally along side `dojo cli`:\n\n```bash\nnpm install -g @dojo/cli-create-widget\n```\n\nRun using:\n\n```bash\ndojo create [widget] --name \u003cwidget name\u003e --styles \u003cCSS path\u003e --tests \u003ctest path\u003e\n```\n\n## Features\n\n`@dojo/cli-create-widget` generates an opinionated skeleton component structure for use within a Dojo 2 application. The location where styles and tests are created can be customized using the `--styles` and `--tests` arguments respectively. By default, the following folder structure will be created:\n\n```\nMyComponent.ts\nstyles/\nstyles/myComponent.m.css\nstyles/myComponent.m.css.d.ts,\ntests/unit/MyComponent.ts\n```\n\nIt's also possible to generate a [Custom Element](https://www.w3.org/TR/2016/WD-custom-elements-20161013/) descriptor by passing the `--component` boolean argument. This will generate a widget that includes the `@customElement` decorator with an empty template object ready for configuration, please see [the `@dojo/widget-core` readme](https://github.com/dojo/widget-core#web-components) for more information.\n\n## How do I contribute?\n\nWe appreciate your interest!  Please see the [Dojo 2 Meta Repository](https://github.com/dojo/meta#readme) for the\nContributing Guidelines.\n\n### Code Style\n\nThis repository uses [`prettier`](https://prettier.io/) for code styling rules and formatting. A pre-commit hook is installed automatically and configured to run `prettier` against all staged files as per the configuration in the projects `package.json`.\n\nAn additional npm script to run `prettier` (with write set to `true`) against all `src` and `test` project files is available by running:\n\n```bash\nnpm run prettier\n```\n\n### Installation\n\nTo start working with this package, clone the repository and run `npm install`.\n\nIn order to build the project run `grunt dev` or `grunt dist`.\n\n### Testing\n\nTest cases MUST be written using [Intern](https://theintern.github.io) using the Object test interface and Assert assertion interface.\n\n90% branch coverage MUST be provided for all code submitted to this repository, as reported by istanbul’s combined coverage results for all supported platforms.\n\nTo test locally run:\n\n`grunt test`\n\n## Licensing information\n\n© 2018 [JS Foundation](https://js.foundation/). [New BSD](http://opensource.org/licenses/BSD-3-Clause) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdojo%2Fcli-create-widget","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdojo%2Fcli-create-widget","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdojo%2Fcli-create-widget/lists"}