Skip to content
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.

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

Update guidance about package-lock.json #1220

Merged
merged 2 commits into from
Apr 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 13 additions & 4 deletions doc/developer_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,19 @@ performs a pip editable install of Panel.
Developing custom models
------------------------

If you are adding or editing a bokeh model, you can use `panel build
panel` to build the javascript. The `build` command is just an alias
for `bokeh build`; see the `Bokeh developer guide`_ for more
information about developing bokeh models.
Panel ships with a number of custom Bokeh models, which have both
Python and Javascript components. When developing Panel these custom
models have to be compiled. This happens automatically with `pip
install -e .` or `python setup.py develop`, however when runnning
actively developing you can rebuild the extension with `panel build
panel`. The `build` command is just an alias for `bokeh build`; see
the `Bokeh developer guide`_ for more information about developing
bokeh models.

Just like any other Javascript (or Typescript) library Panel defines a
`package.json` and `package-lock.json` files. When adding, updating or
removing a dependency in the package.json file ensure you commit the
changes to the `package-lock.json` after running `npm install`.


Next Steps
Expand Down
2 changes: 1 addition & 1 deletion panel/package-lock.json

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