docs: update comments

mrholek · mrholek · commit 9a35bd85d1d9 · 2023-01-06T15:08:02.000+01:00
diff --git a/package.json b/package.json
@@ -41,6 +41,7 @@
     "lint": "eslint \"src/**/*.{js,ts,tsx}\""
   },
   "devDependencies": {
+    "@rollup/plugin-replace": "^5.0.2",
     "@rollup/plugin-typescript": "^10.0.1",
     "@typescript-eslint/eslint-plugin": "^5.46.0",
     "@typescript-eslint/parser": "^5.46.0",
diff --git a/src/deep-objects-merge.ts b/src/deep-objects-merge.ts
@@ -1,3 +1,10 @@
+/**
+ * --------------------------------------------------------------------------
+ * CoreUI (__COREUI_VERSION__): deep-objects-merge.ts
+ * Licensed under MIT (https://github.com/coreui/coreui-utils/blob/master/LICENSE)
+ * --------------------------------------------------------------------------
+ */
+
 const deepObjectsMerge = (target: object, source: object) => {
   // Iterate through `source` properties and if an `Object` set property to merge of `target` and `source` properties
   for (const key of Object.keys(source)) {
diff --git a/src/get-color.ts b/src/get-color.ts
@@ -1,3 +1,10 @@
+/**
+ * --------------------------------------------------------------------------
+ * CoreUI (__COREUI_VERSION__): get-color.ts
+ * Licensed under MIT (https://github.com/coreui/coreui-utils/blob/master/LICENSE)
+ * --------------------------------------------------------------------------
+ */
+
 import getStyle from './get-style'
 
 const getColor = (rawProperty: string, element = document.body) => {
diff --git a/src/hex-to-rgb.ts b/src/hex-to-rgb.ts
@@ -1,3 +1,10 @@
+/**
+ * --------------------------------------------------------------------------
+ * CoreUI (__COREUI_VERSION__): hex-to-rgb.ts
+ * Licensed under MIT (https://github.com/coreui/coreui-utils/blob/master/LICENSE)
+ * --------------------------------------------------------------------------
+ */
+
 /* eslint-disable no-magic-numbers */
 const hexToRgb = (color: string) => {
   if (typeof color === 'undefined') {
diff --git a/src/hex-to-rgba.ts b/src/hex-to-rgba.ts
@@ -1,3 +1,10 @@
+/**
+ * --------------------------------------------------------------------------
+ * CoreUI (__COREUI_VERSION__): hex-to-rgba.ts
+ * Licensed under MIT (https://github.com/coreui/coreui-utils/blob/master/LICENSE)
+ * --------------------------------------------------------------------------
+ */
+
 /* eslint-disable no-magic-numbers */
 const hexToRgba = (color: string, opacity = 100) => {
   if (typeof color === 'undefined') {
diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,10 @@
+/**
+ * --------------------------------------------------------------------------
+ * CoreUI (__COREUI_VERSION__): index.ts
+ * Licensed under MIT (https://github.com/coreui/coreui-utils/blob/master/LICENSE)
+ * --------------------------------------------------------------------------
+ */
+
 import deepObjectsMerge from './deep-objects-merge'
 import getColor from './get-color'
 import getStyle from './get-style'
@@ -8,20 +15,6 @@ import omitByKeys from './omit-by-keys'
 import pickByKeys from './pick-by-keys'
 import rgbToHex from './rgb-to-hex'
 
-// const utils = {
-//   deepObjectsMerge,
-//   getColor,
-//   getStyle,
-//   hexToRgb,
-//   hexToRgba,
-//   makeUid,
-//   omitByKeys,
-//   pickByKeys,
-//   rgbToHex
-// }
-
-// export default utils
-
 export {
   deepObjectsMerge,
   getColor,
diff --git a/src/index.umd.ts b/src/index.umd.ts
@@ -1,7 +1,7 @@
 /**
  * --------------------------------------------------------------------------
- * CoreUI (v3.0.0-rc.0): index.umd.js
- * Licensed under MIT (https://coreui.io/license)
+ * CoreUI (__COREUI_VERSION__): index.umd.ts
+ * Licensed under MIT (https://github.com/coreui/coreui-utils/blob/master/LICENSE)
  * --------------------------------------------------------------------------
  */
 
diff --git a/src/make-uid.ts b/src/make-uid.ts
@@ -1,3 +1,10 @@
+/**
+ * --------------------------------------------------------------------------
+ * CoreUI (__COREUI_VERSION__): make-uid.ts
+ * Licensed under MIT (https://github.com/coreui/coreui-utils/blob/master/LICENSE)
+ * --------------------------------------------------------------------------
+ */
+
 //function for UI releted ID assignment, due to one in 10^15 probability of duplication
 const makeUid = () => {
   const key = Math.random().toString(36).substr(2)
diff --git a/src/omit-by-keys.ts b/src/omit-by-keys.ts
@@ -1,3 +1,10 @@
+/**
+ * --------------------------------------------------------------------------
+ * CoreUI (__COREUI_VERSION__): omit-by-keys.ts
+ * Licensed under MIT (https://github.com/coreui/coreui-utils/blob/master/LICENSE)
+ * --------------------------------------------------------------------------
+ */
+
 const omitByKeys = (originalObject: object, keys: string | string[]) => {
   const newObj = {}
   const objKeys = Object.keys(originalObject)
diff --git a/src/pick-by-keys.ts b/src/pick-by-keys.ts
@@ -1,3 +1,10 @@
+/**
+ * --------------------------------------------------------------------------
+ * CoreUI (__COREUI_VERSION__): pick-by-keys.ts
+ * Licensed under MIT (https://github.com/coreui/coreui-utils/blob/master/LICENSE)
+ * --------------------------------------------------------------------------
+ */
+
 const pickByKeys = (originalObject: object, keys: string | string[]) => {
   const newObj = {}
   for (let i = 0; i < keys.length; i++) {
diff --git a/src/rgb-to-hex.ts b/src/rgb-to-hex.ts
@@ -1,3 +1,10 @@
+/**
+ * --------------------------------------------------------------------------
+ * CoreUI (__COREUI_VERSION__): rgb-to-hex.ts
+ * Licensed under MIT (https://github.com/coreui/coreui-utils/blob/master/LICENSE)
+ * --------------------------------------------------------------------------
+ */
+
 const rgbToHex = (color: string) => {
   if (typeof color === 'undefined') {
     throw new TypeError('Hex color is not defined')
