Skip to content

Update package.json for publishing #4284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 9, 2025
Merged

Update package.json for publishing #4284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
166a66f
Update package.json for publishing
wch Sep 3, 2025
e919536
Use custom readme file for npm
wch Sep 3, 2025
c59fbe5
Update repository URLs
wch Sep 3, 2025
734fc86
Script cleanup
wch Sep 3, 2025
e513071
Use name @posit/shiny
wch Sep 3, 2025
3d351d3
Merge branch 'main' into publish-npm
wch Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions npm-README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
@posit/shiny
============

This npm package contains TypeScript type definitions for Shiny's client-side JavaScript libraries.

It does not include the Shiny framework itself, though that may change in the future.

[Shiny](https://github.com/rstudio/shiny) is a web application framework for both R and Python, developed by Posit PBC.

## Installation

```bash
npm install @posit/shiny
```
16 changes: 9 additions & 7 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"private": true,
"homepage": "https://shiny.rstudio.com",
"repository": "github:rstudio/shiny",
"name": "@types/rstudio-shiny",
"homepage": "https://shiny.posit.co",
"repository": {
"type": "git",
"url": "git+https://github.com/rstudio/shiny.git"
},
"name": "@posit/shiny",
"version": "1.11.1-alpha.9000",
"license": "GPL-3.0-only",
"main": "",
"browser": "",
"types": "srcts/types/extras/globalShiny.d.ts",
"files": [
"DESCRIPTION",
"LICENSE",
"NEWS.md",
"srcts/types/**/*.d.ts"
],
"engines": {
Expand Down Expand Up @@ -69,7 +69,9 @@
"build_types": "tsc -p tsconfig.json",
"coverage_detailed": "npx --yes type-check --detail",
"coverage": "type-coverage -p tsconfig.json --at-least 90",
"circular": "npx --yes dpdm --transform ./srcts/src/index.ts"
"circular": "npx --yes dpdm --transform ./srcts/src/index.ts",
"prepack": "cp README.md README-orig.md && cp npm-README.md README.md",
Copy link
Collaborator Author

@wch wch Sep 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: It looks like yarn pack does not ignore README-orig.md (so it gets included in the package), but npm pack does ignore the file, which is the behavior that we want.

From what I can find, it's going to require awkward stuff to make yarn pack ignore that file, like moving the temporary file to /tmp. Since we're planning on switching to npm anyway, I suggest we just leave this as it is. We can publish it with npm publish just fine, even if we're using yarn for other steps.

"postpack": "test -f README-orig.md && cp README-orig.md README.md && rm README-orig.md"
},
"prettier": {
"plugins": [
Expand Down
Loading