Skip to content

Commit

Permalink
[code-infra] Unpin the version of docs-utils in scripts (#41232)
Browse files Browse the repository at this point in the history
Signed-off-by: Michał Dudak <[email protected]>
Co-authored-by: Flavien DELANGLE <[email protected]>
  • Loading branch information
michaldudak and flaviendelangle authored Feb 22, 2024
1 parent bd143f4 commit 0aca7ac
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 24 deletions.
5 changes: 5 additions & 0 deletions packages-internal/scripts/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## 1.0.1

- Unpinned version of the @mui-internal/docs-utils dependency.
- Corrected the README file.

## 1.0.0

Initial release as an npm package.
Expand Down
29 changes: 8 additions & 21 deletions packages-internal/scripts/README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,12 @@
# @mui-internal/typescript-to-proptypes
# @mui/internal-scripts

An API for converting [TypeScript](https://www.npmjs.com/package/typescript) definitions to [PropTypes](https://www.npmjs.com/package/prop-types) using the TypeScript Compiler API.

This package has been adapted for MUI needs.
Code infra scripts for MUI repositories
It is not meant for general use.

## Support

| Component type | |
| :--------------- | :----------------- |
| Class | :heavy_check_mark: |
| Function | :heavy_check_mark: |
| Const functions | :heavy_check_mark: |
| React.memo | :heavy_check_mark: |
| React.ForwardRef | :heavy_check_mark: |

## License

This project is licensed under the terms of the [MIT license](/LICENSE).

## Release
## Scripts

1. Build the project: `pnpm build`
2. Publish the build artifacts to npm: `pnpm release:publish`
- `build` - transpiles TS files into the build directory.
- `release:publish` - builds the project and publishes it in the npm registry.
- `release:publish:dry-run` - builds the project and publishes it in a local registry accessible on port 4873 (this is the default port of Verdaccio private npm server).
- `test` - runs all the tests.
- `typescript` - checks validity of types.
4 changes: 2 additions & 2 deletions packages-internal/scripts/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@mui/internal-scripts",
"version": "1.0.0",
"version": "1.0.1",
"author": "MUI Team",
"description": "Utilities supporting MUI libraries build and docs generation. This is an internal package not meant for general use.",
"main": "build/index.js",
Expand Down Expand Up @@ -30,7 +30,7 @@
"@babel/plugin-syntax-jsx": "^7.23.3",
"@babel/plugin-syntax-typescript": "^7.23.3",
"@babel/types": "^7.23.9",
"@mui-internal/docs-utils": "workspace:*",
"@mui-internal/docs-utils": "workspace:^",
"doctrine": "^3.0.0",
"lodash": "^4.17.21",
"typescript": "^5.3.3",
Expand Down
2 changes: 1 addition & 1 deletion pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 0aca7ac

Please sign in to comment.