-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5dab93e
commit 01bbb3b
Showing
1 changed file
with
27 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,33 @@ | ||
# @wordpress/ts-config | ||
# Typescript config (@wordpress/ts-config) | ||
|
||
TypeScript configuration for WordPress Gutenberg packages. | ||
A sharable TypeScript configuration package for WordPress projects. | ||
|
||
## Installation | ||
|
||
Install the module | ||
|
||
```bash | ||
npm install @wordpress/ts-config --save-dev | ||
$ npm install @wordpress/ts-config --save-dev | ||
``` | ||
|
||
**Note**: This package requires Node.js version with long-term support status (check [Active LTS or Maintenance LTS releases](https://nodejs.org/en/about/previous-releases)). It is not compatible with older versions. | ||
|
||
## Usage | ||
|
||
Extend the base TypeScript configuration in your `tsconfig.json` file: | ||
|
||
```json | ||
{ | ||
"extends": "@wordpress/ts-config/tsconfig.base.json" | ||
} | ||
``` | ||
|
||
This ensures consistency across WordPress projects and aligns with Gutenberg's TypeScript standards. | ||
|
||
## Contributing to this package | ||
|
||
This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects. | ||
|
||
To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md). | ||
|
||
<br /><br /><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p> |