Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
help-me-respond
Advanced tools
help-me-respond - npm Package Compare versions
Comparing version 2.6.0 to 2.6.1
| { | ||
| "name": "help-me-respond", | ||
| "version": "2.6.0", | ||
| "version": "2.6.1", | ||
| "description": "Simple nodejs Express http response helper", | ||
@@ -31,5 +31,7 @@ "main": "index.js", | ||
| "dependencies": { | ||
| "i18n-nodejs": "^2.0.0", | ||
| "mocha": "^4.1.0" | ||
| "i18n-nodejs": "2.0.0" | ||
| }, | ||
| "devDependencies": { | ||
| "mocha": "8.1.3" | ||
| } | ||
| } |
165
README.md
| ## Help me respond | ||
| Hello there :) | ||
| Hello there :) 👋🏼 | ||
| Thank you for your interest in *help-me-respond*! | ||
| Any feedback is highly appreciated. In case you run into problems please feel free to create an issue for me at [https://github.com/Symphony9/help-me-respond/issues](https://github.com/Symphony9/help-me-respond/issues) | ||
| In case you run into problems please feel free to create an issue for me at [the Issues Tab](https://github.com/piggydoughnut/help-me-respond/issues) | ||
| Have fun coding using this little lib <3 | ||
| Your feedback is highly appreciated! 🌸 | ||
| ## About | ||
| [Prerequisites for usage](README.md#prerequisites-for-usage) | ||
| This is a simple response helper which should make your life a bit easier. It supports localization and friendly messages for users. | ||
| Help-me-respond preconfigures HTTP responses for you by setting the status code, processing the message and setting headers. You only need to call one of the API functions and pass the message in a form of a string or an object to it. | ||
| [Installation](README.md#installation) | ||
| ## UPDATES | ||
| [Localization](README.md#localization) | ||
| [Pass arguments to your messages](README.md#pass-arguments-to-your-messages) | ||
| 08.01.2018 | ||
| [API](README.md#api) | ||
| The library became lighter! :) I removed config library dependency in order to minimize dependencies, however you can still use it since the config folder structure I am following here is the same as for the [node-config](https://github.com/lorenwest/node-config); | ||
| [Response examples](README.md#response-examples) | ||
| The library is **easier to configure**. No need to configure anything :) Just start using it! | ||
| ## About | ||
| **Localization** became optional. | ||
| This is a simple response helper which should make your life a bit easier. | ||
| It supports localization and friendly messages for users. | ||
| ### BREAKING CHANGES: | ||
| `Help-me-respond` preconfigures HTTP responses for you by setting the status code, processing the message and setting headers. You only need to call one of the API functions and pass the message in a form of a string or an object to it. | ||
| Removed *code* key from the error response message object. If u were using this, please use the code in the Express HTTP Response object. | ||
| [Release info](https://github.com/piggydoughnut/help-me-respond/releases) | ||
| Removed `http502`. | ||
| ## Prerequisites for usage | ||
| Your project is a `nodejs` server based on `Express` or something similar. Help-me-respond uses the `res` object from Express, which represents an HTTP response. | ||
| ## Prerequisites for usage | ||
| Your project is a nodejs server based on Express or something similar. Help-me-respond uses the res object from Express, which represents an HTTP response. | ||
| ## Setup | ||
| ## Installation | ||
| ### Install with | ||
| ``` | ||
@@ -45,100 +44,96 @@ npm i help-me-respond --save | ||
| *OPTIONAL*: Create *config/messages.json* file. We don't want our messages to be hardcoded in the code, so we will keep them in a separate file. | ||
| 1. Create a *config/* folder in the root of your project. That is where all the config for the library lives. | ||
| 2. Create *config/default.json* for the general library config | ||
| ``` | ||
| { | ||
| "MESSAGE_NAME1": "Very long and important message text.", | ||
| "MESSAGE_NAME2": "Very long and important message text2." | ||
| "logging": false, | ||
| "prefixNone": false, # when you server returns any data, a prefix "data" is added to the response | ||
| "disableJsonHeader": false # remove the default 'application/json' header | ||
| "friendlyMessages": [] # array of message keys which are defined in message.json or locales.json | ||
| } | ||
| ``` | ||
| ## Configuration | ||
| 3. Create *config/messages.json* for the response messages and friendly messages setup. | ||
| All the configurations are put in **config/** folder in the root of your project. | ||
| ``` | ||
| { | ||
| "welcome": "Welcome to the platform!", | ||
| "notFound": "Unfortunately the given record was not found. Please check your input details." | ||
| } | ||
| ``` | ||
| ### Logging | ||
| **config/default.json** | ||
| ### Friendly Messages | ||
| Some messages returned from the server are too technical for users. We want to differentiate between those messages and user friendly messages. See example below. | ||
| To enable Friendly messages you just need to edit the *config/default.json* and specify which messages are the friendly ones. The messages itself have to be defined in the *config/messages.json* (or *config/locales.json* if you are using localization). | ||
| { | ||
| "logging": true | ||
| } | ||
| ``` | ||
| config/default.json | ||
| `False` by default. | ||
| { | ||
| "friendlyMessages": ["welcome", "notFound"] | ||
| } | ||
| ``` | ||
| Once the message name is in the above array, the response object will have a key *friendlyMessage* which makes it easy for front-end to differentiate between messages. | ||
| ### User friendly messages | ||
| Some messages returned from the server are too technical for users. So we would like to differentiate between those messages and user friendly messages. See example below. You can use it for messages in *messages.json* or *locales.json* | ||
| ## Localization | ||
| **config/messages.json** | ||
| Sometimes you need to support more than one language. | ||
| { | ||
| "messageOne": "This is the first message", | ||
| "messageTwo": "This is the second message" | ||
| } | ||
| 1. This is a basic setup for the [i18n-nodejs](https://github.com/eslam-mahmoud/i18n-nodejs). | ||
| ``` | ||
| config/default.json | ||
| **config/default.json** | ||
| { | ||
| "lang": "en", | ||
| "langFile": "../../config/locales.json" | ||
| } | ||
| ``` | ||
| { | ||
| "friendlyMessages": ["messageOne", "messageTwo"] | ||
| } | ||
| `lang` is the default language of your application | ||
| Once the message name is in the above array, the response will have a key **friendlyMessage** which makes it easy for front-end to differentiate between messages. | ||
| `langFile` path is used in the library therefore, the path is relative to the *index.js* file from *help-me-respond* folder | ||
| 2. Create `config/locales.json` file and add some messages there. | ||
| ``` | ||
| config/locales.json | ||
| ### Localization | ||
| You will need to add the following to your **config/default.json** file. This is a basic setup for the i18n-nodejs - https://github.com/eslam-mahmoud/i18n-nodejs | ||
| { | ||
| "lang": "en", | ||
| "langFile": "../../config/locales.json" | ||
| { | ||
| "SHARING_ERROR": { | ||
| "en": "You cannot share the link with yourself." | ||
| }, | ||
| "NOT_OWNER": { | ||
| "en": "You are not the owner." | ||
| } | ||
| } | ||
| ``` | ||
| *langFile* path is used in the library therefore, the path is relative to the *index.js* file from *help-me-respond* folder | ||
| ### Pass arguments to your messages | ||
| * Create the specified above locales folder and locales file and add some messages there. | ||
| This works only if you are using localization. | ||
| ``` | ||
| config/locales.json | ||
| { | ||
| "SHARING_ERROR": { | ||
| "en": "You cannot share the link with yourself." | ||
| }, | ||
| "NOT_OWNER": { | ||
| "en": "You are not the owner." | ||
| } | ||
| "welcome": "Welcome dear {{name}}" | ||
| } | ||
| ``` | ||
| ### Pass arguments to your messages | ||
| This works only if you are using localization. | ||
| **config/locales.json** | ||
| { | ||
| "welcome": "Welcome dear {{name}}", | ||
| ``` | ||
| http200(res, JSON.stringify({ | ||
| msg: 'welcome', | ||
| args: { | ||
| name: 'Mike' | ||
| } | ||
| })) | ||
| ``` | ||
| **somewhere in the code** | ||
| http200(res, JSON.stringify({ | ||
| msg: 'welcome', | ||
| args: { | ||
| name: 'Mike' | ||
| } | ||
| })); | ||
| ### Turn off data prefix | ||
| When you server returns any data, a prefix **data** is added to response. | ||
| You can turn it off by setting **prefixNone** to **true** in your config file. For more info about config see [Config setup](#config-setup) above. | ||
| ### Turn off default 'application/json' header | ||
| Remove the default *application/json* header by setting **disableJsonHeader** to **true** in your config file. For more info about config see [Config setup](#config-setup) above. | ||
| ## API | ||
@@ -145,0 +140,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Dependency count
- decreased by-50%
1
Worsened metrics
- Total package byte prevSize
- decreased by-2.44%
17057
- Dev dependency count
- increased byInfinity%
1
- Number of lines in readme file
- decreased by-2.11%
232
Dependency changes
- Removedmocha@^4.1.0
- Removedbalanced-match@1.0.2(transitive)
- Removedbrace-expansion@1.1.11(transitive)
- Removedbrowser-stdout@1.3.0(transitive)
- Removedcommander@2.11.0(transitive)
- Removedconcat-map@0.0.1(transitive)
- Removeddebug@3.1.0(transitive)
- Removeddiff@3.3.1(transitive)
- Removedescape-string-regexp@1.0.5(transitive)
- Removedfs.realpath@1.0.0(transitive)
- Removedglob@7.1.2(transitive)
- Removedgrowl@1.10.3(transitive)
- Removedhas-flag@2.0.0(transitive)
- Removedhe@1.1.1(transitive)
- Removedinflight@1.0.6(transitive)
- Removedinherits@2.0.4(transitive)
- Removedminimatch@3.1.2(transitive)
- Removedminimist@0.0.8(transitive)
- Removedmkdirp@0.5.1(transitive)
- Removedmocha@4.1.0(transitive)
- Removedms@2.0.0(transitive)
- Removedonce@1.4.0(transitive)
- Removedpath-is-absolute@1.0.1(transitive)
- Removedsupports-color@4.4.0(transitive)
- Removedwrappy@1.0.2(transitive)
Updatedi18n-nodejs@2.0.0