feat: modernize package

kenany · kenany · commit 33844f79555e · 2023-05-15T18:45:31.000-04:00
BREAKING CHANGE: The minimum supported Node.js version is now v16.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1 @@
-* text=auto
+* text=auto eol=lf
diff --git a/.github/renovate.json b/.github/renovate.json
@@ -0,0 +1,7 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "local>kenany/renovate-config",
+    ":assignAndReview(kenany)"
+  ]
+}
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -0,0 +1,29 @@
+name: nodejs
+on: [pull_request, push]
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number || github.ref }}
+  cancel-in-progress: true
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node-version: [16, 18, 20]
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+    steps:
+    - name: Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3.6.0
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Update npm
+      run: |
+        npm install -g npm
+        npm --version
+    - uses: actions/checkout@v3.5.2
+    - name: Install dependencies
+      uses: bahmutov/npm-install@v1.8.29
+      with:
+        useLockFile: false
+    - run: npm ls
+    - name: Test
+      run: npm test
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,27 @@
+name: release
+on:
+  push:
+    branches:
+      - master
+jobs:
+  release:
+    name: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v2.5.1
+        with:
+          node-version: 20
+      - name: Update npm
+        run: |
+          npm install -g npm
+          npm --version
+      - uses: actions/checkout@v3.5.2
+      - name: Install dependencies
+        uses: bahmutov/npm-install@v1.8.29
+        with:
+          useLockFile: false
+      - name: Release
+        run: npm run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+package-lock = false
diff --git a/.releaserc.json b/.releaserc.json
@@ -0,0 +1,12 @@
+{
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/github",
+    "@semantic-release/npm",
+    "@semantic-release/git"
+  ],
+  "preset": "conventionalcommits",
+  "tagFormat": "${version}"
+}
diff --git a/.travis.yml b/.travis.yml
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,4 +1,4 @@
-Copyright 2013–2014 Kenan Yildirim <http://kenany.me/>
+Copyright 2013–2023 Kenan Yildirim <http://kenany.me/>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -15,4 +15,4 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,14 +1,11 @@
 # caps-rate
 
-[![Build Status](https://travis-ci.org/nwitch/caps-rate.svg?branch=master)](https://travis-ci.org/nwitch/caps-rate)
-[![Dependency Status](https://gemnasium.com/nwitch/caps-rate.svg)](https://gemnasium.com/nwitch/caps-rate)
-
 Get how much a string IS YELLING.
 
 ## Example
 
 ``` javascript
-var caps = require('caps-rate');
+const caps = require('caps-rate');
 
 caps('hello WORLD');
 // => 0.45454545454545453
@@ -23,9 +20,9 @@ $ npm install caps-rate
 ## API
 
 ``` javascript
-var caps = require('caps-rate');
+const caps = require('caps-rate');
 ```
 
 ### caps(value)
 
-Returns how frequently caps are used in `value`.
+Returns how frequently caps are used in `value`.
diff --git a/index.js b/index.js
@@ -1,19 +1,25 @@
+'use strict';
+
+/**
+ * @param {string} value
+ * @returns {number}
+ */
 module.exports = function(value) {
-  var length = value.length;
+  const length = value.length;
 
   // A string with a length of 0 will obviously have no caps.
   if (!length) {
     return 0;
   }
 
-  var caps = 0;
-  var index = -1;
+  let caps = 0;
+  let index = -1;
   while (++index < length) {
-    var chr = value.charAt(index);
+    const chr = value.charAt(index);
     if (chr.toLowerCase() !== chr && chr.toUpperCase() === chr) {
       caps++;
     }
   }
 
   return caps / length;
-};
+};
diff --git a/package.json b/package.json
@@ -14,16 +14,25 @@
   ],
   "main": "index.js",
   "files": [
+    "CHANGELOG.md",
     "index.js",
     "LICENSE.txt"
   ],
   "directories": {
     "test": "test"
   },
+  "engines": {
+    "node": "16 || 18 || >=20"
+  },
   "scripts": {
+    "release": "semantic-release",
     "test": "tape test/index.js"
   },
   "devDependencies": {
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "conventional-changelog-conventionalcommits": "^5.0.0",
+    "semantic-release": "^21.0.2",
     "tape": "^2.1.0"
   }
-}
+}
