moderndash 0.0.13 → 0.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +93 -0
  3. package/package.json +3 -3
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022 Maximilian Dewald
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,93 @@
1
+ ![ModernDash Logo](/website/src/assets/moderndashLogo.svg)
2
+
3
+ <p align=center>
4
+ A Typescript-First utility library inspired by Lodash.
5
+ Optimized for modern browsers.
6
+ </p>
7
+ <p align=center>
8
+ ✅ ESM
9
+ ✅ Tree-shakable
10
+ ✅ Typescript Strict Mode (no any types)
11
+ ✅ Zero dependencies
12
+ </p>
13
+
14
+ -------
15
+
16
+ > **Warning**
17
+ > This library is still in development and is not ready for production use.
18
+
19
+ ## Documentation
20
+ The documentation is WIP.
21
+ [Documentation](https://moderndash.io/)
22
+
23
+ ## Removed Functions because of trivial native alternatives
24
+ Look at [You-Dont-Need-Lodash](https://github.com/you-dont-need/You-Dont-Need-Lodash-Underscore) for native replacements.
25
+
26
+ ### Array Functions
27
+ - compact
28
+ - concat
29
+ - differenceBy property shorthand
30
+ - drop
31
+ - dropRight
32
+ - fill
33
+ - findIndex
34
+ - findLastIndex
35
+ - first/head
36
+ - flatten
37
+ - flattenDeep
38
+ - flattenDepth
39
+ - fromPairs
40
+ - initial
41
+ - join
42
+ - last
43
+ - lastIndexOf
44
+ - nth
45
+ - without
46
+ - reverse
47
+ - slice
48
+ - sortedIndexOf
49
+ - tail
50
+ - take
51
+ - takeRight
52
+ - without
53
+
54
+ ### Collection Functions
55
+ - each/forEach
56
+ - every
57
+ - filter
58
+ - find
59
+ - flatMap
60
+ - includes
61
+
62
+ ### String Functions
63
+ - lowerCase
64
+ - trim
65
+ - trimEnd
66
+ - trimStart
67
+ - pad
68
+ - padEnd
69
+ - padStart
70
+
71
+ Functions are not considered trivial if they:
72
+ - include reduce methods
73
+ - include multiple nested function calls
74
+
75
+ ## TODO
76
+ - More unzip tests
77
+ - Check if flatmapdeep, flatmapDepth is included in native flatmap
78
+ - GroupBy Property Shorthand
79
+
80
+ ## Might be added later (open for discussion)
81
+ - pull functions (pull, pullAll, pullAllBy, pullAllWith, pullAt)
82
+ - remove
83
+ - sorted functions (sortedIndex, sortedIndexBy, sortedIndexOf, sortedLastIndex, sortedLastIndexBy, sortedLastIndexOf, sortedUniq, sortedUniqBy)
84
+ - if performance is better than native alternatives (testing needed)
85
+ - xor functions (xor, xorBy, xorWith)
86
+ - zipObject, zipObjectDeep
87
+ - forEachRight
88
+ - findLast
89
+ - lowerFirst
90
+ - keyBy
91
+
92
+ ## Continue at
93
+ - invokeMap
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "moderndash",
3
- "version": "0.0.13",
3
+ "version": "0.0.14",
4
4
  "type": "module",
5
5
  "description": "A lodash inspired utility framework for ESM/Typescript/ES2020",
6
6
  "scripts": {
7
7
  "build": "ctix create ----startAt src --overwrite --noBackup & tsup",
8
- "prepublishOnly": "npm run build && cp '../README.md' './README.md' && cp '../LICENSE' './LICENSE'",
9
- "postpublish": "rm './README.md' && rm './LICENSE'",
8
+ "prepublishOnly": "npm run build && @powershell cp '../README.md' './README.md' && @powershell cp '../LICENSE' './LICENSE'",
9
+ "postpublish": "@powershell rm './README.md' && @powershell rm './LICENSE'",
10
10
  "test": "vitest",
11
11
  "test-ui": "vitest --ui"
12
12
  },