natural 5.1.10 → 5.1.11

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '38 9 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

package/CONTRIBUTING.md

@@ -1,9 +1,33 @@
-Please always create unit test for your contributions, and make sure they are passing.
+# Contributing
 
-Tests are created using jasmine
+When contributing to this repository, please explain your changes or additions in an issue or in the pull request. 
 
-You can run unit tests by:
-* `npm test` or
-* `make test`
+When developing, please:
 
-See `Makefile` for additional test suites
+* Comply with Standard JS. This is tested when you commit to natural.
+* Prevent code duplication. Use jscpd to test this. This is tested when you commit to natural.
+* Write unit tests for jasmine. Make sure your unit tests pass.
+* For compatibility with browsers, do not use the file system fs. If you need to read files, use JSON and require.
+* Write documentation and commit this to the gh-pages branch.
+* The current configuration of the unit tests requires the following environment variable to be set:
+```
+    export NODE_PATH=.
+```
+
+# CD/CD pipeline
+The repository uses Github Actions for testing and publishing.
+
+Currently, there three workflows:
+
+* Node CI: tests natural on the four most recent releases of Nodejs. Code coverage is analysed with Istanbul. Results are forwarded to Coveralls. In the README a badge shows the coverage.
+* Nodejs package: The natural package is automatically published to NPM when a release is created (tagged).
+* Lint Code Base: the repository is linted using the Github super linter which includes jslint and jscpd.
+* CodeQL for detecting security vulnerabilities.
+Github workflows can be found in the folder ./.github/workflows.
+
+# Versioning
+We apply semantic versioning. Given natural’s version number MAJOR.MINOR.PATCH, increment the:
+
+* MAJOR version when you make incompatible API changes,
+* MINOR version when you add functionality in a backwards compatible manner, and
+* PATCH version when you make backwards compatible bug fixes.

package/README.md

@@ -6,7 +6,6 @@
 [![GitHub Super-Linter](https://github.com/NaturalNode/natural/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
 [![Coverage Status](https://coveralls.io/repos/github/NaturalNode/natural/badge.svg?branch=master)](https://coveralls.io/github/NaturalNode/natural?branch=master)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4651/badge)](https://bestpractices.coreinfrastructure.org/projects/4651)
-[![Slack](https://slack.bri.im/badge.svg)](https://slack.bri.im)
 
 "Natural" is a general natural language facility for nodejs. It offers a broad range of functionalities for natural language processing. Documentation can be found [here on Github Pages](http://naturalnode.github.io/natural/).
 

package/SECURITY.md

@@ -0,0 +1,23 @@
+# Security Policy
+
+##
+
+We run dependabot and Github's CodeQL analysis to detect security problems.
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.10   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :x: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+If you find a vulnerability please report a security issue in the Issues section of the repository. If you know how to fix it, create a pull request.
+
+We will analyse the issue, and repair it a.s.a.p (best effort).

package/lib/natural/distance/dice_coefficient.js

@@ -51,7 +51,7 @@ function intersect (set1, set2) {
 function sanitize (str) {
   // Turn characters to lower string, remove space at the beginning and end,
   // replace multiple spaces in the middle by single spaces
-  return str.toLowerCase().replace(/^\s+|\s+$/g, '').replace(/s+/g, ' ')
+  return str.toLowerCase().replace(/\s+/g, ' ').replace(/^\s+|\s+$/g, '')
 }
 
 function diceCoefficient (str1, str2) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "natural",
   "description": "General natural language (tokenizing, stemming (English, Russian, Spanish), part-of-speech tagging, sentiment analysis, classification, inflection, phonetics, tfidf, WordNet, jaro-winkler, Levenshtein distance, Dice's Coefficient) facilities for node.",
-  "version": "5.1.10",
+  "version": "5.1.11",
   "homepage": "https://github.com/NaturalNode/natural",
   "repository": {
     "type": "git",