You've already forked joplin
mirror of
https://github.com/laurent22/joplin.git
synced 2025-08-13 22:12:50 +02:00
Generator: Added "npm run update" command
This commit is contained in:
@@ -49,11 +49,11 @@ In general all this is done automatically by the plugin generator, which will se
|
|||||||
|
|
||||||
## Updating the plugin framework
|
## Updating the plugin framework
|
||||||
|
|
||||||
To update the plugin framework, run `npm install -g generator-joplin && yo joplin --update`
|
To update the plugin framework, run `npm run update`.
|
||||||
|
|
||||||
Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
|
In general this command tries to do the right thing - in particular it's going to merge the changes in package.json and .gitignore instead of overwriting. It will also leave "/src" as well as README.md untouched.
|
||||||
|
|
||||||
For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
|
The file that may cause problem is "webpack.config.js" because it's going to be overwritten. For that reason, if you want to change it, consider creating a separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
|
||||||
|
|
||||||
## Content scripts
|
## Content scripts
|
||||||
|
|
||||||
|
@@ -49,11 +49,11 @@ In general all this is done automatically by the plugin generator, which will se
|
|||||||
|
|
||||||
## Updating the plugin framework
|
## Updating the plugin framework
|
||||||
|
|
||||||
To update the plugin framework, run `yo joplin --update`
|
To update the plugin framework, run `npm run update`.
|
||||||
|
|
||||||
Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
|
In general this command tries to do the right thing - in particular it's going to merge the changes in package.json and .gitignore instead of overwriting. It will also leave "/src" as well as README.md untouched.
|
||||||
|
|
||||||
For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
|
The file that may cause problem is "webpack.config.js" because it's going to be overwritten. For that reason, if you want to change it, consider creating a separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
|
||||||
|
|
||||||
## Content scripts
|
## Content scripts
|
||||||
|
|
||||||
|
@@ -17,8 +17,8 @@ The project is setup to use TypeScript, although you can change the configuratio
|
|||||||
|
|
||||||
## Updating the plugin framework
|
## Updating the plugin framework
|
||||||
|
|
||||||
To update the plugin framework, run `yo joplin --update`
|
To update the plugin framework, run `npm run update`.
|
||||||
|
|
||||||
Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.
|
In general this command tries to do the right thing - in particular it's going to merge the changes in package.json and .gitignore instead of overwriting. It will also leave "/src" as well as README.md untouched.
|
||||||
|
|
||||||
For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
|
The file that may cause problem is "webpack.config.js" because it's going to be overwritten. For that reason, if you want to change it, consider creating a separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
|
||||||
|
@@ -3,7 +3,8 @@
|
|||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dist": "webpack",
|
"dist": "webpack",
|
||||||
"prepare": "npm run dist"
|
"prepare": "npm run dist",
|
||||||
|
"update": "npm install -g generator-joplin && yo joplin --update"
|
||||||
},
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
|
Reference in New Issue
Block a user