Deprecate calling shescape directly

CHANGELOG.md

@@ -9,6 +9,10 @@ Versioning].
 
 - _No changes yet_
 
+## [0.3.1] - 2020-12-07
+
+- Deprecate calling `shescape()` directly.
+
 ## [0.3.0] - 2020-12-07
 
 - Add `escape` function to escape an argument (same as `shescape()`).

index.js

@@ -3,6 +3,9 @@ const os = require("os");
 const main = require("./src/main.js");
 
 module.exports = function (arg) {
+  console.warn(
+    "calling shescape() directly is deprecated since v0.3.1 and will be removed in v1.0.0"
+  );
   const platform = os.platform();
   return main.escapeShellArgByPlatform(arg, platform);
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "shescape",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "simple shell escape library",
   "homepage": "https://github.com/ericcornelissen/shescape#readme",
   "license": "MPL-2.0",

test/index.test.js

@@ -23,6 +23,15 @@ describe("index.js", function () {
     main.escapeShellArgByPlatform.restore();
   });
 
+  it("informs about deprecation of calling shescape directly", function () {
+    sinon.spy(console, "warn");
+
+    shescape("foobar");
+    assert(console.warn.called);
+
+    console.warn.restore();
+  });
+
   it("escape calls main for current OS", function () {
     const osStubOutput = "MundOS";
     sinon.stub(os, "platform").returns(osStubOutput);