Update markdownlint-cli dev dependency (#4241)

* Update markdownlint-cli dev dependency
And fix https://github.com/advisories/GHSA-6vfc-qv3f-vr6c

* npm ci
pull/4243/head
Alexandre Alapetite 3 years ago committed by GitHub
parent 1fe66ad020
commit 7c74653cc2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      .github/workflows/tests.yml
  2. 12
      docs/en/developers/03_Backend/05_Extensions.md
  3. 2
      docs/en/users/03_Main_view.md
  4. 4
      docs/fr/developers/03_Backend/05_Extensions.md
  5. 2
      docs/fr/users/01_Installation.md
  6. 2
      docs/fr/users/07_Frequently_Asked_Questions.md
  7. 3685
      package-lock.json
  8. 2
      package.json

@ -58,7 +58,7 @@ jobs:
node-version: '14' node-version: '14'
cache: 'npm' cache: 'npm'
- run: npm install - run: npm ci
- name: Check JavaScript syntax - name: Check JavaScript syntax
run: npm run --silent eslint run: npm run --silent eslint

@ -277,22 +277,22 @@ Only the `name` and `entrypoint` fields are required.
### Choosing between `system` and `user` ### Choosing between `system` and `user`
A __user__ extension can be enabled by some users and not by others (typically for user preferences). A *user* extension can be enabled by some users and not by others (typically for user preferences).
A __system__ extension in comparison is enabled for every account. A *system* extension in comparison is enabled for every account.
### Writing your own extension.php ### Writing your own extension.php
This file is the core of your extension. This file is the core of your extension.
It must define some key elements to be loaded by the extension system: It must define some key elements to be loaded by the extension system:
1. The class name must be the `entrypoint` value defined in the `metadata.json` file suffixed by `Extension` (if your `entrypoint` value is _HelloWorld_, your class name will be _HelloWorldExtension_). 1. The class name must be the `entrypoint` value defined in the `metadata.json` file suffixed by `Extension` (if your `entrypoint` value is `HelloWorld`, your class name will be `HelloWorldExtension`).
1. The class must extend the `Minz_Extension` abstract class which defines the core methods and properties of a FreshRSS extension. 1. The class must extend the `Minz_Extension` abstract class which defines the core methods and properties of a FreshRSS extension.
1. The class must define the `init` method. This method is called **only** if the extension is loaded. Its purpose is to initialize the extension and its behavior during every page load. 1. The class must define the `init` method. This method is called **only** if the extension is loaded. Its purpose is to initialize the extension and its behavior during every page load.
The `Minz_Extension` abstract class defines a set of methods that can be overridden to fit your needs: The `Minz_Extension` abstract class defines a set of methods that can be overridden to fit your needs:
* the `install` method is called when the user enables the extension in the configuration page. It must return _true_ when successful and a string containing an error message when not. Its purpose is to prepare FreshRSS for the extension (adding a table to the database, creating a folder tree, …). * the `install` method is called when the user enables the extension in the configuration page. It must return `true` when successful and a string containing an error message when not. Its purpose is to prepare FreshRSS for the extension (adding a table to the database, creating a folder tree, …).
* the `uninstall` method is called when the user disables the extension in the configuration page. It must return _true_ when successful and a string containing an error message when not. Its purpose is to clean FreshRSS (removing a table from the database, deleting a folder tree, …). Usually it reverts changes introduced by the `install` method. * the `uninstall` method is called when the user disables the extension in the configuration page. It must return `true` when successful and a string containing an error message when not. Its purpose is to clean FreshRSS (removing a table from the database, deleting a folder tree, …). Usually it reverts changes introduced by the `install` method.
* the `handleConfigureAction` method is called when a user loads the extension configuration panel. It contains the logic to validate and store the submitted values defined in the `configure.phtml` file. * the `handleConfigureAction` method is called when a user loads the extension configuration panel. It contains the logic to validate and store the submitted values defined in the `configure.phtml` file.
> If your extension code is scattered in different classes, you need to load their source before using them. Of course you could include the files manually, but it’s more efficient to load them automatically. To do so, you just need to define the `autoload` method which will include them when needed. This method will be registered automatically when the extension is enabled. > If your extension code is scattered in different classes, you need to load their source before using them. Of course you could include the files manually, but it’s more efficient to load them automatically. To do so, you just need to define the `autoload` method which will include them when needed. This method will be registered automatically when the extension is enabled.
@ -300,7 +300,7 @@ The `Minz_Extension` abstract class defines a set of methods that can be overrid
The `Minz_Extension` abstract class defines another set of methods that should not be overridden: The `Minz_Extension` abstract class defines another set of methods that should not be overridden:
* the `getName`, `getEntrypoint`, `getPath`, `getAuthor`, `getDescription`, `getVersion`, and `getType` methods return the extension internal properties. Those properties are extracted from the `metadata.json` file. * the `getName`, `getEntrypoint`, `getPath`, `getAuthor`, `getDescription`, `getVersion`, and `getType` methods return the extension internal properties. Those properties are extracted from the `metadata.json` file.
* the `getFileUrl` returns the URL of the selected file. The file must exist in the `static` folder of the extension. * the `getFileUrl` returns the URL of the selected file. The file must exist in the `static` folder of the extension.
* the `registerController` method register an extension controller in FreshRSS. The selected controller must be defined in the extension _Controllers_ folder, its file name must be _\<name\>Controller.php_, and its class name must be *FreshExtension_\<name\>_Controller*. * the `registerController` method register an extension controller in FreshRSS. The selected controller must be defined in the extension *Controllers* folder, its file name must be `\<name\>Controller.php`, and its class name must be `FreshExtension_\<name\>_Controller`.
* the `registerViews` method registers the extension views in FreshRSS. * the `registerViews` method registers the extension views in FreshRSS.
* the `registerTranslates` method registers the extension translation files in FreshRSS. * the `registerTranslates` method registers the extension translation files in FreshRSS.
* the `registerHook` method registers hook actions in different part of the application. * the `registerHook` method registers hook actions in different part of the application.

@ -252,7 +252,7 @@ You can change the sort order by clicking the toggle button available in the hea
Once you came up with your perfect filter, it would be a shame if you need to recreate it every time you need to use it. Once you came up with your perfect filter, it would be a shame if you need to recreate it every time you need to use it.
Hopefully, there is a way to bookmark them for later use. Hopefully, there is a way to bookmark them for later use.
We call them _user queries_. We call them *user queries*.
You can create as many as you want, the only limit is how they will be displayed on your screen. You can create as many as you want, the only limit is how they will be displayed on your screen.
### Bookmark the current query ### Bookmark the current query

@ -449,10 +449,10 @@ Seuls les champs `name` et `entrypoint` sont requis.
### Choisir entre extension « system » ou « user » ### Choisir entre extension « system » ou « user »
A __user__ extension can be enabled by some users and not by others A *user* extension can be enabled by some users and not by others
(typically for user preferences). (typically for user preferences).
A __system__ extension in comparison is enabled for every account. A *system* extension in comparison is enabled for every account.
### Writing your own extension.php ### Writing your own extension.php

@ -88,7 +88,7 @@ Comme son nom l’indique, il s’agit de la version sur laquelle les développe
Voici un fichier de configuration pour nginx. Il couvre la configuration pour HTTP, HTTPS, et PHP. Voici un fichier de configuration pour nginx. Il couvre la configuration pour HTTP, HTTPS, et PHP.
_Vous pourrez trouver d’autres fichiers de configuration plus simples mais ces derniers ne seront peut-être pas compatibles avec l’API FreshRSS._ *Vous pourrez trouver d’autres fichiers de configuration plus simples mais ces derniers ne seront peut-être pas compatibles avec l’API FreshRSS.*
```nginx ```nginx
server { server {

@ -107,6 +107,6 @@ Exemples avec _uBlock_ :
* Ajoutez votre instance FreshRSS à la liste blanche de en l’ajoutant dans * Ajoutez votre instance FreshRSS à la liste blanche de en l’ajoutant dans
_uBlock > Ouvrir le tableau de bord > Liste blanche_. _uBlock > Ouvrir le tableau de bord > Liste blanche_.
*-* Autorisez votre instance FreshRSS à appeler la page de configuration * Autorisez votre instance FreshRSS à appeler la page de configuration
`sharing` en ajoutant la règle `*sharing,domain=~votredomaine.com` dans `sharing` en ajoutant la règle `*sharing,domain=~votredomaine.com` dans
_uBlock > Ouvrir le fichier tableau de bord > Mes filtres_ _uBlock > Ouvrir le fichier tableau de bord > Mes filtres_

3685
package-lock.json generated

File diff suppressed because it is too large Load Diff

@ -35,7 +35,7 @@
"eslint-plugin-import": "^2.25.4", "eslint-plugin-import": "^2.25.4",
"eslint-plugin-node": "^11.1.0", "eslint-plugin-node": "^11.1.0",
"eslint-plugin-promise": "^5.2.0", "eslint-plugin-promise": "^5.2.0",
"markdownlint-cli": "^0.30.0", "markdownlint-cli": "^0.31.1",
"rtlcss": "^3.5.0", "rtlcss": "^3.5.0",
"sass": "^1.49.0", "sass": "^1.49.0",
"stylelint": "^14.3.0", "stylelint": "^14.3.0",

Loading…
Cancel
Save