Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@wethegit/components
Advanced tools
For how to use the components, see the [Documentation](https://wethegit.github.io/component-library/).
For how to use the components, see the Documentation.
To learn how to contribute, continue reading.
It's important to know that this library is never compiled. The source files are provided as is. They are meant to be copied into your project.
Make sure you using the required Node version from nvmrc.
You will develop and test the components with Storybook.
From the root of the repository, run:
yarn
yarn start
This will start Storybook and watch for changes in the components' source files.
When adding a new file, ensure the component is also exported from the main src/components/index.tsx
file:
// src/components/index.tsx
export * from "./button"
Export only the necessary pieces of the component and their types from the component's index.tsx
file.
// src/components/button/index.tsx
export { Button } from "./button"
export type { ButtonProps } from "./button"
If your component requires node packages as dependencies, add them to the peerDependencies
and devDependencies
:
Run these command from this directory, not from the root, otherwise they will be dependencies to the whole monorepo.
First add as a peer dependency:
yarn add <package-name> -P
Then as a dev dependency:
yarn add <package-name> -D
If a component is using a node package without types, add a declaration file with the name of the package, without special characters, to the ./types
directory:
// ./types/<package-name>.d.ts
declare module "<package-name>"
After you have added your component and is ready to release it, you need to add it to the CLI.
Add an entry to registry-index.ts following the required types described in that file.
After that's all done you can release a new version following the instructions in the project's readme.
FAQs
For how to use the components, see the [Documentation](https://wethegit.github.io/component-library/).
The npm package @wethegit/components receives a total of 29 weekly downloads. As such, @wethegit/components popularity was classified as not popular.
We found that @wethegit/components demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.