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.

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

Jump to bottom

Remove plugin.json library property #8686

Closed
pitaj opened this issue Sep 26, 2020 · 2 comments
Closed

Remove plugin.json library property #8686

pitaj opened this issue Sep 26, 2020 · 2 comments
Assignees
@pitaj
Labels
breaking change (plugins) breaking change (themes) tech debt
Milestone
1.15.0

Comments

@pitaj
Copy link
Contributor

pitaj commented Sep 26, 2020 •
edited

The package.json property main fulfills this purpose, making library redundant. This also will allow us to simplify our code to just require(plugin.id) to get the plugin libraries.

Will deprecate the existing usage, issuing a warning if requiring the plugin as above fails, forcing us to fallback to library. Any error will cause us to fallback to library, for instance several themes define "main": "theme.less", which will error when required, since theme.less is not a valid Node module.

Plugin Authors:

  • In package.json, set "main": "your/entry/point.js" for forwards compatibility
  • In plugin.json, set "library": "." for backwards compatibility
@pitaj pitaj self-assigned this Sep 26, 2020
pitaj added a commit that referenced this issue Sep 26, 2020
@pitaj
fix: #8686, deprecate plugin.json/library
924a3f8 
and also fix deprecated hooks with no alternative
@oplik0 oplik0 mentioned this issue Sep 26, 2020
Merged
oplik0 added a commit to Wieloswiat/nodebb-plugin-modmin that referenced this issue Sep 26, 2020
@oplik0
Add main to package.json
86b9249 
Ref: NodeBB/NodeBB#8686
pitaj added a commit that referenced this issue Sep 27, 2020
@pitaj
fix: #8686, deprecate plugin.json/library
85886c6 
and also fix deprecated hooks with no alternative
pitaj added a commit that referenced this issue Sep 27, 2020
@pitaj
fix: #8686, deprecate plugin.json/library
45db816 
and also fix deprecated hooks with no alternative
@barisusakli barisusakli added this to the 1.15.0 milestone Oct 1, 2020
bennvan added a commit to bennvan/nodebb-theme-oxide that referenced this issue Feb 1, 2021
@bennvan
Update package.json
c08cc57 
as NodeBB/NodeBB#8686
bennvan added a commit to bennvan/nodebb-theme-oxide that referenced this issue Feb 1, 2021
@bennvan
Update plugin.json
9c3d64e 
as NodeBB/NodeBB#8686
pitaj added a commit to pitaj/nodebb-plugin-calendar that referenced this issue Mar 11, 2021
@pitaj
Convert to typescript
bdf25cd 
Add pre-release checklist
Remove babel
Fix repetition translations and editor
- now correctly shows repeat day of week
- now currently hide and reset custom repeat inputs
NodeBB/NodeBB#8686
Fix editing event posts
Fix repetition algorithm
Hide response buttons, fix visibility privs
Fix notifs not being translated
Bump dependencies
@braco
Copy link

braco commented Jan 1, 2024

This convention is still in your quickstart repo:

https://github.com/NodeBB/nodebb-theme-quickstart/blob/master/plugin.json#L3

@barisusakli
Copy link
Member

@braco
NodeBB/nodebb-theme-quickstart@c1fff76

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pitaj pitaj

Labels
breaking change (plugins) breaking change (themes) tech debt
Projects
None yet
Milestone
1.15.0
Development

No branches or pull requests
3 participants
@pitaj @braco @barisusakli