@opndev/util 0.0.7 → 0.0.9

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2020-2024 Wesley Schwengle
+
+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 the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 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.

package/lib/any.mjs

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2021-2024 Wesley Schwengle <wesley@opndev.io>
+//
+// SPDX-License-Identifier: MIT
+
 /**
  * Check if a value is preset in the given array, can be done via a function or
  * a primitive. Objects tend to be harder. Use lodash instead.

package/lib/defined.mjs

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2021-2024 Wesley Schwengle <wesley@opndev.io>
+//
+// SPDX-License-Identifier: MIT
+
 /**
  * Check if a variable is defined
  * @function defined

package/lib/index.mjs

@@ -1,3 +1,9 @@
+// SPDX-FileCopyrightText: 2021-2024, 2026 Wesley Schwengle <wesley@opndev.io>
+//
+// SPDX-License-Identifier: MIT
+
+const VERSION = "0.0.9";
+
 /**
  *
  * @module module:@opndev/utils
@@ -18,3 +24,5 @@ export { defined } from './defined.mjs'
 export { pow_of_two } from './powtwo.mjs'
 export { is_pow_of_two } from './ispowtwo.mjs'
 export { range } from './range.mjs'
+export { ucFirst } from './ucFirst.mjs'
+export { lcFirst } from './lcFirst.mjs'

package/lib/ispowtwo.mjs

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023, 2024 Wesley Schwengle <wesley@opndev.io>
+//
+// SPDX-License-Identifier: MIT
+
 /**
  * Check if something is the power of two
  * @function is_pow_of_two

package/lib/lcFirst.mjs

@@ -0,0 +1,17 @@
+// SPDX-FileCopyrightText: 2024 Wesley Schwengle <wesley@opndev.io>
+//
+// SPDX-License-Identifier: MIT
+
+/**
+ * Check if a value is preset in the given array, can be done via a function or
+ * a primitive. Objects tend to be harder. Use lodash instead.
+ *
+ * @function lcFirst
+ * @param {String} string Anything
+ * @returns {String} string With the first letter uppercased
+ */
+export default function lcFirst(string) {
+  return string.charAt(0).toLowerCase() + string.slice(1);
+}
+
+export { lcFirst }

package/lib/none.mjs

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023, 2024 Wesley Schwengle <wesley@opndev.io>
+//
+// SPDX-License-Identifier: MIT
+
 /**
  * Check if a value is not preset in the given array, can be done via a
  * function or a primitive.

package/lib/powtwo.mjs

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023, 2024 Wesley Schwengle <wesley@opndev.io>
+//
+// SPDX-License-Identifier: MIT
+
 /**
  * Returns the power of two
  * @function pow_of_two

package/lib/range.mjs

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2023, 2024 Wesley Schwengle <wesley@opndev.io>
+//
+// SPDX-License-Identifier: MIT
+
 /**
  * Return a range
  * @function range

package/lib/ucFirst.mjs

@@ -0,0 +1,17 @@
+// SPDX-FileCopyrightText: 2024 Wesley Schwengle <wesley@opndev.io>
+//
+// SPDX-License-Identifier: MIT
+
+/**
+ * Check if a value is preset in the given array, can be done via a function or
+ * a primitive. Objects tend to be harder. Use lodash instead.
+ *
+ * @function ucFirst
+ * @param {String} string Anything
+ * @returns {String} string With the first letter uppercased
+ */
+export default function ucFirst(string) {
+  return string.charAt(0).toUpperCase() + string.slice(1);
+}
+
+export { ucFirst }

package/package.json

@@ -1,35 +1,43 @@
 {
-  "name": "@opndev/util",
-  "version": "0.0.7",
-  "description": "Utility functions for OPN Development",
-  "main": "lib/index.mjs",
-  "type": "module",
-  "mode": "auto",
-  "sideEffects": false,
-  "homepage": "https://opndev.gitlab.io/javascript/opndev-js-util/",
-  "repository": {
-    "url": "git+https://gitlab.com/opndev/javascript/opndev-js-util.git"
-  },
-  "bugs": {
-    "url": "https://gitlab.com/opndev/javascript/opndev-js-util/issues"
-  },
-  "scripts": {
-    "test": "tap",
-    "jsdoc" : "jsdoc -c jsdoc.json"
-  },
   "author": {
-    "name": "Wesley Schwengle",
     "email": "wesley@opndev.io",
+    "name": "Wesley Schwengle",
     "url": "https://opndev.io"
   },
-  "license": "MIT",
+  "bugs": {
+    "url": "https://gitlab.com/opndev/javascript/opndev-js-util/-/issues"
+  },
+  "description": "Utility functions for OPN Development",
   "devDependencies": {
-    "jsdoc" : "latest",
+    "jsdoc": "latest",
     "tap": "latest"
   },
-  "files": [
-    "lib/*.mjs",
-    "README.md",
-    "Changes"
-  ]
+  "exports": {
+    ".": "./lib/index.mjs",
+    "./any": "./lib/any.mjs",
+    "./defined": "./lib/defined.mjs",
+    "./is_pow_of_two": "./lib/is_pow_of_two.mjs",
+    "./lcFirst": "./lib/lcFirst.mjs",
+    "./none": "./lib/none.mjs",
+    "./pow_of_two": "./lib/pow_of_two.mjs",
+    "./range": "./lib/range.mjs",
+    "./ucFirst": "./lib/ucFirst.mjs"
+  },
+  "homepage": "https://opndev.gitlab.io/javascript/opndev-js-util/",
+  "keywords": [
+    "utility"
+  ],
+  "license": "MIT",
+  "name": "@opndev/util",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/opndev/javascript/opndev-js-util.git"
+  },
+  "scripts": {
+    "jsdoc": "jsdoc -c jsdoc.json",
+    "test": "tap"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "version": "0.0.9"
 }

package/Changes

@@ -1,37 +0,0 @@
-Revision history for @opndev/util
-
-0.0.7
-
-    * Add additional information when throwing an error in pow functions
-    * Bump requirements for node-tap
-
-0.0.6
-
-    * Maintainer release:
-        * Make use of gitlab pages for documenation
-    * Add none() function
-    * Add range() function
-    * Bugfix: Allow string values in pow_* functions
-
-0.0.5   2023-08-27 15:33:21-0400
-
-    * Include .mjs files in package
-
-0.0.4   2023-08-27 15:13:21-0400
-
-    * Add two mathematical functions:
-        * is_pow_of_two
-        * pow_of_two
-
-0.0.3       2021-11-12 17:15:02-0400
-
-    * maintainer release for ESM
-
-0.0.2       2020-05-15 16:19:23Z
-
-    * Allow any() to check for integers as well
-    * Update README.md
-
-0.0.1       2020-05-13 02:42:33Z
-
-    * First release

package/README.md

@@ -1,49 +0,0 @@
-# Welcome to @opndev/util
-
-This is a utility function package that tries to solve issues by keeping things
-DRY. It is an ESM package.
-
-[If you want to know more, have a look at our documenation](https://opndev.gitlab.io/javascript/opndev-js-util/)
-
-## Development
-
-Try to keep functions small and try not to depend on any outside functions. We
-aim to keep the dependency graph as small as possible. The use of `esm` is
-welcomed and writing tests is encouraged.
-
-### jsdoc
-
-You can build the documentation by running `npm run jsdoc`.
-
-### eslint
-
-The ES Linting profile is flexible and does not try to enforce much. There is
-more than one way to do it ([TIMTOWTDI](https://en.wikipedia.org/wiki/There%27s_more_than_one_way_to_do_it)).
-
-Try to stay constistent, but forcing a programming style upon others is bad.
-
-### gitignore
-
-Please educate yourself and use a global gitignore file. Somes files will
-always be there. I'm looking at you `node_modules`.
-
-### The lockfiles
-You'll also see that `package-lock.json` and/or `yarn.lock` are ignored. I
-strongly believe that pinning packages lead to bit rot, as you never update
-packages. When a downstream module breaks its API you should know and update
-your code accordingly. The same goes for possible upstream modules. If you want
-a specific version, pin it to that version, otherwise use the latest and
-greatest when possible.
-
-### Code of conduct
-
-There is none, stay human, communicate and accept that some people have
-different opinions.
-
-### Pull requests
-
-I'm happy to accept pull requests, just make sure your change has tests.
-Add a good commit message and commit with a sign-off `git commit -s`.
-
-A good commit message isn't just `issue(feat): added foo to bar` but also
-explain the why in the commit.