@cdktn/provider-project 0.7.24

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 (330) hide show
  1. package/.jsii +419 -0
  2. package/API.md +4154 -0
  3. package/CLAUDE.md +172 -0
  4. package/LICENSE +355 -0
  5. package/README.md +82 -0
  6. package/lib/alert-open-prs.d.ts +14 -0
  7. package/lib/alert-open-prs.js +67 -0
  8. package/lib/auto-approve.d.ts +11 -0
  9. package/lib/auto-approve.js +70 -0
  10. package/lib/auto-close-community-issues.d.ts +15 -0
  11. package/lib/auto-close-community-issues.js +104 -0
  12. package/lib/automerge.d.ts +11 -0
  13. package/lib/automerge.js +67 -0
  14. package/lib/cdktf-config.d.ts +33 -0
  15. package/lib/cdktf-config.js +134 -0
  16. package/lib/copyright-headers.d.ts +4 -0
  17. package/lib/copyright-headers.js +44 -0
  18. package/lib/customized-license.d.ts +8 -0
  19. package/lib/customized-license.js +19 -0
  20. package/lib/dependabot.d.ts +8 -0
  21. package/lib/dependabot.js +40 -0
  22. package/lib/deprecate-packages.d.ts +14 -0
  23. package/lib/deprecate-packages.js +91 -0
  24. package/lib/force-release.d.ts +12 -0
  25. package/lib/force-release.js +112 -0
  26. package/lib/github-issues.d.ts +15 -0
  27. package/lib/github-issues.js +33 -0
  28. package/lib/index.d.ts +53 -0
  29. package/lib/index.js +447 -0
  30. package/lib/lock-issues.d.ts +13 -0
  31. package/lib/lock-issues.js +54 -0
  32. package/lib/package-info.d.ts +14 -0
  33. package/lib/package-info.js +7 -0
  34. package/lib/provider-upgrade.d.ts +17 -0
  35. package/lib/provider-upgrade.js +145 -0
  36. package/lib/readme.d.ts +21 -0
  37. package/lib/readme.js +147 -0
  38. package/lib/scripts/check-for-upgrades.d.ts +15 -0
  39. package/lib/scripts/check-for-upgrades.js +186 -0
  40. package/lib/scripts/should-release.d.ts +13 -0
  41. package/lib/scripts/should-release.js +96 -0
  42. package/lib/util/random-cron.d.ts +18 -0
  43. package/lib/util/random-cron.js +33 -0
  44. package/mise.toml +2 -0
  45. package/node_modules/camel-case/LICENSE +21 -0
  46. package/node_modules/camel-case/README.md +47 -0
  47. package/node_modules/camel-case/dist/index.d.ts +5 -0
  48. package/node_modules/camel-case/dist/index.js +23 -0
  49. package/node_modules/camel-case/dist/index.js.map +1 -0
  50. package/node_modules/camel-case/dist/index.spec.d.ts +1 -0
  51. package/node_modules/camel-case/dist/index.spec.js +26 -0
  52. package/node_modules/camel-case/dist/index.spec.js.map +1 -0
  53. package/node_modules/camel-case/dist.es2015/index.d.ts +5 -0
  54. package/node_modules/camel-case/dist.es2015/index.js +17 -0
  55. package/node_modules/camel-case/dist.es2015/index.js.map +1 -0
  56. package/node_modules/camel-case/dist.es2015/index.spec.d.ts +1 -0
  57. package/node_modules/camel-case/dist.es2015/index.spec.js +24 -0
  58. package/node_modules/camel-case/dist.es2015/index.spec.js.map +1 -0
  59. package/node_modules/camel-case/package.json +89 -0
  60. package/node_modules/capital-case/LICENSE +21 -0
  61. package/node_modules/capital-case/README.md +37 -0
  62. package/node_modules/capital-case/dist/index.d.ts +4 -0
  63. package/node_modules/capital-case/dist/index.js +16 -0
  64. package/node_modules/capital-case/dist/index.js.map +1 -0
  65. package/node_modules/capital-case/dist/index.spec.d.ts +1 -0
  66. package/node_modules/capital-case/dist/index.spec.js +24 -0
  67. package/node_modules/capital-case/dist/index.spec.js.map +1 -0
  68. package/node_modules/capital-case/dist.es2015/index.d.ts +4 -0
  69. package/node_modules/capital-case/dist.es2015/index.js +11 -0
  70. package/node_modules/capital-case/dist.es2015/index.js.map +1 -0
  71. package/node_modules/capital-case/dist.es2015/index.spec.d.ts +1 -0
  72. package/node_modules/capital-case/dist.es2015/index.spec.js +22 -0
  73. package/node_modules/capital-case/dist.es2015/index.spec.js.map +1 -0
  74. package/node_modules/capital-case/package.json +90 -0
  75. package/node_modules/change-case/LICENSE +21 -0
  76. package/node_modules/change-case/README.md +44 -0
  77. package/node_modules/change-case/dist/index.d.ts +11 -0
  78. package/node_modules/change-case/dist/index.js +15 -0
  79. package/node_modules/change-case/dist/index.js.map +1 -0
  80. package/node_modules/change-case/dist/index.spec.d.ts +1 -0
  81. package/node_modules/change-case/dist/index.spec.js +9 -0
  82. package/node_modules/change-case/dist/index.spec.js.map +1 -0
  83. package/node_modules/change-case/dist.es2015/index.d.ts +11 -0
  84. package/node_modules/change-case/dist.es2015/index.js +12 -0
  85. package/node_modules/change-case/dist.es2015/index.js.map +1 -0
  86. package/node_modules/change-case/dist.es2015/index.spec.d.ts +1 -0
  87. package/node_modules/change-case/dist.es2015/index.spec.js +7 -0
  88. package/node_modules/change-case/dist.es2015/index.spec.js.map +1 -0
  89. package/node_modules/change-case/package.json +101 -0
  90. package/node_modules/constant-case/LICENSE +21 -0
  91. package/node_modules/constant-case/README.md +37 -0
  92. package/node_modules/constant-case/dist/index.d.ts +3 -0
  93. package/node_modules/constant-case/dist/index.js +12 -0
  94. package/node_modules/constant-case/dist/index.js.map +1 -0
  95. package/node_modules/constant-case/dist/index.spec.d.ts +1 -0
  96. package/node_modules/constant-case/dist/index.spec.js +26 -0
  97. package/node_modules/constant-case/dist/index.spec.js.map +1 -0
  98. package/node_modules/constant-case/dist.es2015/index.d.ts +3 -0
  99. package/node_modules/constant-case/dist.es2015/index.js +8 -0
  100. package/node_modules/constant-case/dist.es2015/index.js.map +1 -0
  101. package/node_modules/constant-case/dist.es2015/index.spec.d.ts +1 -0
  102. package/node_modules/constant-case/dist.es2015/index.spec.js +24 -0
  103. package/node_modules/constant-case/dist.es2015/index.spec.js.map +1 -0
  104. package/node_modules/constant-case/package.json +90 -0
  105. package/node_modules/dot-case/LICENSE +21 -0
  106. package/node_modules/dot-case/README.md +37 -0
  107. package/node_modules/dot-case/dist/index.d.ts +3 -0
  108. package/node_modules/dot-case/dist/index.js +11 -0
  109. package/node_modules/dot-case/dist/index.js.map +1 -0
  110. package/node_modules/dot-case/dist/index.spec.d.ts +1 -0
  111. package/node_modules/dot-case/dist/index.spec.js +26 -0
  112. package/node_modules/dot-case/dist/index.spec.js.map +1 -0
  113. package/node_modules/dot-case/dist.es2015/index.d.ts +3 -0
  114. package/node_modules/dot-case/dist.es2015/index.js +7 -0
  115. package/node_modules/dot-case/dist.es2015/index.js.map +1 -0
  116. package/node_modules/dot-case/dist.es2015/index.spec.d.ts +1 -0
  117. package/node_modules/dot-case/dist.es2015/index.spec.js +24 -0
  118. package/node_modules/dot-case/dist.es2015/index.spec.js.map +1 -0
  119. package/node_modules/dot-case/package.json +89 -0
  120. package/node_modules/fs-extra/LICENSE +15 -0
  121. package/node_modules/fs-extra/README.md +262 -0
  122. package/node_modules/fs-extra/lib/copy/copy-sync.js +169 -0
  123. package/node_modules/fs-extra/lib/copy/copy.js +235 -0
  124. package/node_modules/fs-extra/lib/copy/index.js +7 -0
  125. package/node_modules/fs-extra/lib/empty/index.js +39 -0
  126. package/node_modules/fs-extra/lib/ensure/file.js +69 -0
  127. package/node_modules/fs-extra/lib/ensure/index.js +23 -0
  128. package/node_modules/fs-extra/lib/ensure/link.js +64 -0
  129. package/node_modules/fs-extra/lib/ensure/symlink-paths.js +99 -0
  130. package/node_modules/fs-extra/lib/ensure/symlink-type.js +31 -0
  131. package/node_modules/fs-extra/lib/ensure/symlink.js +82 -0
  132. package/node_modules/fs-extra/lib/fs/index.js +128 -0
  133. package/node_modules/fs-extra/lib/index.js +16 -0
  134. package/node_modules/fs-extra/lib/json/index.js +16 -0
  135. package/node_modules/fs-extra/lib/json/jsonfile.js +11 -0
  136. package/node_modules/fs-extra/lib/json/output-json-sync.js +12 -0
  137. package/node_modules/fs-extra/lib/json/output-json.js +12 -0
  138. package/node_modules/fs-extra/lib/mkdirs/index.js +14 -0
  139. package/node_modules/fs-extra/lib/mkdirs/make-dir.js +27 -0
  140. package/node_modules/fs-extra/lib/mkdirs/utils.js +21 -0
  141. package/node_modules/fs-extra/lib/move/index.js +7 -0
  142. package/node_modules/fs-extra/lib/move/move-sync.js +54 -0
  143. package/node_modules/fs-extra/lib/move/move.js +75 -0
  144. package/node_modules/fs-extra/lib/output-file/index.js +40 -0
  145. package/node_modules/fs-extra/lib/path-exists/index.js +12 -0
  146. package/node_modules/fs-extra/lib/remove/index.js +22 -0
  147. package/node_modules/fs-extra/lib/remove/rimraf.js +302 -0
  148. package/node_modules/fs-extra/lib/util/stat.js +154 -0
  149. package/node_modules/fs-extra/lib/util/utimes.js +26 -0
  150. package/node_modules/fs-extra/package.json +67 -0
  151. package/node_modules/graceful-fs/LICENSE +15 -0
  152. package/node_modules/graceful-fs/README.md +143 -0
  153. package/node_modules/graceful-fs/clone.js +23 -0
  154. package/node_modules/graceful-fs/graceful-fs.js +448 -0
  155. package/node_modules/graceful-fs/legacy-streams.js +118 -0
  156. package/node_modules/graceful-fs/package.json +53 -0
  157. package/node_modules/graceful-fs/polyfills.js +355 -0
  158. package/node_modules/header-case/LICENSE +21 -0
  159. package/node_modules/header-case/README.md +37 -0
  160. package/node_modules/header-case/dist/index.d.ts +3 -0
  161. package/node_modules/header-case/dist/index.js +11 -0
  162. package/node_modules/header-case/dist/index.js.map +1 -0
  163. package/node_modules/header-case/dist/index.spec.d.ts +1 -0
  164. package/node_modules/header-case/dist/index.spec.js +24 -0
  165. package/node_modules/header-case/dist/index.spec.js.map +1 -0
  166. package/node_modules/header-case/dist.es2015/index.d.ts +3 -0
  167. package/node_modules/header-case/dist.es2015/index.js +7 -0
  168. package/node_modules/header-case/dist.es2015/index.js.map +1 -0
  169. package/node_modules/header-case/dist.es2015/index.spec.d.ts +1 -0
  170. package/node_modules/header-case/dist.es2015/index.spec.js +22 -0
  171. package/node_modules/header-case/dist.es2015/index.spec.js.map +1 -0
  172. package/node_modules/header-case/package.json +89 -0
  173. package/node_modules/jsonfile/LICENSE +15 -0
  174. package/node_modules/jsonfile/README.md +230 -0
  175. package/node_modules/jsonfile/index.js +88 -0
  176. package/node_modules/jsonfile/package.json +40 -0
  177. package/node_modules/jsonfile/utils.js +14 -0
  178. package/node_modules/lower-case/LICENSE +21 -0
  179. package/node_modules/lower-case/README.md +35 -0
  180. package/node_modules/lower-case/dist/index.d.ts +8 -0
  181. package/node_modules/lower-case/dist/index.js +53 -0
  182. package/node_modules/lower-case/dist/index.js.map +1 -0
  183. package/node_modules/lower-case/dist/index.spec.d.ts +1 -0
  184. package/node_modules/lower-case/dist/index.spec.js +36 -0
  185. package/node_modules/lower-case/dist/index.spec.js.map +1 -0
  186. package/node_modules/lower-case/dist.es2015/index.d.ts +8 -0
  187. package/node_modules/lower-case/dist.es2015/index.js +48 -0
  188. package/node_modules/lower-case/dist.es2015/index.js.map +1 -0
  189. package/node_modules/lower-case/dist.es2015/index.spec.d.ts +1 -0
  190. package/node_modules/lower-case/dist.es2015/index.spec.js +34 -0
  191. package/node_modules/lower-case/dist.es2015/index.spec.js.map +1 -0
  192. package/node_modules/lower-case/package.json +87 -0
  193. package/node_modules/no-case/LICENSE +21 -0
  194. package/node_modules/no-case/README.md +37 -0
  195. package/node_modules/no-case/dist/index.d.ts +10 -0
  196. package/node_modules/no-case/dist/index.js +35 -0
  197. package/node_modules/no-case/dist/index.js.map +1 -0
  198. package/node_modules/no-case/dist/index.spec.d.ts +1 -0
  199. package/node_modules/no-case/dist/index.spec.js +59 -0
  200. package/node_modules/no-case/dist/index.spec.js.map +1 -0
  201. package/node_modules/no-case/dist.es2015/index.d.ts +10 -0
  202. package/node_modules/no-case/dist.es2015/index.js +31 -0
  203. package/node_modules/no-case/dist.es2015/index.js.map +1 -0
  204. package/node_modules/no-case/dist.es2015/index.spec.d.ts +1 -0
  205. package/node_modules/no-case/dist.es2015/index.spec.js +57 -0
  206. package/node_modules/no-case/dist.es2015/index.spec.js.map +1 -0
  207. package/node_modules/no-case/package.json +85 -0
  208. package/node_modules/param-case/LICENSE +21 -0
  209. package/node_modules/param-case/README.md +37 -0
  210. package/node_modules/param-case/dist/index.d.ts +3 -0
  211. package/node_modules/param-case/dist/index.js +11 -0
  212. package/node_modules/param-case/dist/index.js.map +1 -0
  213. package/node_modules/param-case/dist/index.spec.d.ts +1 -0
  214. package/node_modules/param-case/dist/index.spec.js +24 -0
  215. package/node_modules/param-case/dist/index.spec.js.map +1 -0
  216. package/node_modules/param-case/dist.es2015/index.d.ts +3 -0
  217. package/node_modules/param-case/dist.es2015/index.js +7 -0
  218. package/node_modules/param-case/dist.es2015/index.js.map +1 -0
  219. package/node_modules/param-case/dist.es2015/index.spec.d.ts +1 -0
  220. package/node_modules/param-case/dist.es2015/index.spec.js +22 -0
  221. package/node_modules/param-case/dist.es2015/index.spec.js.map +1 -0
  222. package/node_modules/param-case/package.json +91 -0
  223. package/node_modules/pascal-case/LICENSE +21 -0
  224. package/node_modules/pascal-case/README.md +47 -0
  225. package/node_modules/pascal-case/dist/index.d.ts +5 -0
  226. package/node_modules/pascal-case/dist/index.js +24 -0
  227. package/node_modules/pascal-case/dist/index.js.map +1 -0
  228. package/node_modules/pascal-case/dist/index.spec.d.ts +1 -0
  229. package/node_modules/pascal-case/dist/index.spec.js +25 -0
  230. package/node_modules/pascal-case/dist/index.spec.js.map +1 -0
  231. package/node_modules/pascal-case/dist.es2015/index.d.ts +5 -0
  232. package/node_modules/pascal-case/dist.es2015/index.js +18 -0
  233. package/node_modules/pascal-case/dist.es2015/index.js.map +1 -0
  234. package/node_modules/pascal-case/dist.es2015/index.spec.d.ts +1 -0
  235. package/node_modules/pascal-case/dist.es2015/index.spec.js +23 -0
  236. package/node_modules/pascal-case/dist.es2015/index.spec.js.map +1 -0
  237. package/node_modules/pascal-case/package.json +90 -0
  238. package/node_modules/path-case/LICENSE +21 -0
  239. package/node_modules/path-case/README.md +37 -0
  240. package/node_modules/path-case/dist/index.d.ts +3 -0
  241. package/node_modules/path-case/dist/index.js +11 -0
  242. package/node_modules/path-case/dist/index.js.map +1 -0
  243. package/node_modules/path-case/dist/index.spec.d.ts +1 -0
  244. package/node_modules/path-case/dist/index.spec.js +24 -0
  245. package/node_modules/path-case/dist/index.spec.js.map +1 -0
  246. package/node_modules/path-case/dist.es2015/index.d.ts +3 -0
  247. package/node_modules/path-case/dist.es2015/index.js +7 -0
  248. package/node_modules/path-case/dist.es2015/index.js.map +1 -0
  249. package/node_modules/path-case/dist.es2015/index.spec.d.ts +1 -0
  250. package/node_modules/path-case/dist.es2015/index.spec.js +22 -0
  251. package/node_modules/path-case/dist.es2015/index.spec.js.map +1 -0
  252. package/node_modules/path-case/package.json +88 -0
  253. package/node_modules/sentence-case/LICENSE +21 -0
  254. package/node_modules/sentence-case/README.md +37 -0
  255. package/node_modules/sentence-case/dist/index.d.ts +4 -0
  256. package/node_modules/sentence-case/dist/index.js +19 -0
  257. package/node_modules/sentence-case/dist/index.js.map +1 -0
  258. package/node_modules/sentence-case/dist/index.spec.d.ts +1 -0
  259. package/node_modules/sentence-case/dist/index.spec.js +24 -0
  260. package/node_modules/sentence-case/dist/index.spec.js.map +1 -0
  261. package/node_modules/sentence-case/dist.es2015/index.d.ts +4 -0
  262. package/node_modules/sentence-case/dist.es2015/index.js +14 -0
  263. package/node_modules/sentence-case/dist.es2015/index.js.map +1 -0
  264. package/node_modules/sentence-case/dist.es2015/index.spec.d.ts +1 -0
  265. package/node_modules/sentence-case/dist.es2015/index.spec.js +22 -0
  266. package/node_modules/sentence-case/dist.es2015/index.spec.js.map +1 -0
  267. package/node_modules/sentence-case/package.json +89 -0
  268. package/node_modules/snake-case/LICENSE +21 -0
  269. package/node_modules/snake-case/README.md +37 -0
  270. package/node_modules/snake-case/dist/index.d.ts +3 -0
  271. package/node_modules/snake-case/dist/index.js +11 -0
  272. package/node_modules/snake-case/dist/index.js.map +1 -0
  273. package/node_modules/snake-case/dist/index.spec.d.ts +1 -0
  274. package/node_modules/snake-case/dist/index.spec.js +25 -0
  275. package/node_modules/snake-case/dist/index.spec.js.map +1 -0
  276. package/node_modules/snake-case/dist.es2015/index.d.ts +3 -0
  277. package/node_modules/snake-case/dist.es2015/index.js +7 -0
  278. package/node_modules/snake-case/dist.es2015/index.js.map +1 -0
  279. package/node_modules/snake-case/dist.es2015/index.spec.d.ts +1 -0
  280. package/node_modules/snake-case/dist.es2015/index.spec.js +23 -0
  281. package/node_modules/snake-case/dist.es2015/index.spec.js.map +1 -0
  282. package/node_modules/snake-case/package.json +90 -0
  283. package/node_modules/tslib/CopyrightNotice.txt +15 -0
  284. package/node_modules/tslib/LICENSE.txt +12 -0
  285. package/node_modules/tslib/README.md +164 -0
  286. package/node_modules/tslib/SECURITY.md +41 -0
  287. package/node_modules/tslib/modules/index.d.ts +38 -0
  288. package/node_modules/tslib/modules/index.js +70 -0
  289. package/node_modules/tslib/modules/package.json +3 -0
  290. package/node_modules/tslib/package.json +47 -0
  291. package/node_modules/tslib/tslib.d.ts +460 -0
  292. package/node_modules/tslib/tslib.es6.html +1 -0
  293. package/node_modules/tslib/tslib.es6.js +402 -0
  294. package/node_modules/tslib/tslib.es6.mjs +401 -0
  295. package/node_modules/tslib/tslib.html +1 -0
  296. package/node_modules/tslib/tslib.js +484 -0
  297. package/node_modules/universalify/LICENSE +20 -0
  298. package/node_modules/universalify/README.md +76 -0
  299. package/node_modules/universalify/index.js +24 -0
  300. package/node_modules/universalify/package.json +34 -0
  301. package/node_modules/upper-case/README.md +34 -0
  302. package/node_modules/upper-case/dist/index.d.ts +8 -0
  303. package/node_modules/upper-case/dist/index.js +49 -0
  304. package/node_modules/upper-case/dist/index.js.map +1 -0
  305. package/node_modules/upper-case/dist/index.spec.d.ts +1 -0
  306. package/node_modules/upper-case/dist/index.spec.js +34 -0
  307. package/node_modules/upper-case/dist/index.spec.js.map +1 -0
  308. package/node_modules/upper-case/dist.es2015/index.d.ts +8 -0
  309. package/node_modules/upper-case/dist.es2015/index.js +44 -0
  310. package/node_modules/upper-case/dist.es2015/index.js.map +1 -0
  311. package/node_modules/upper-case/dist.es2015/index.spec.d.ts +1 -0
  312. package/node_modules/upper-case/dist.es2015/index.spec.js +32 -0
  313. package/node_modules/upper-case/dist.es2015/index.spec.js.map +1 -0
  314. package/node_modules/upper-case/package.json +86 -0
  315. package/node_modules/upper-case-first/LICENSE +21 -0
  316. package/node_modules/upper-case-first/README.md +32 -0
  317. package/node_modules/upper-case-first/dist/index.d.ts +4 -0
  318. package/node_modules/upper-case-first/dist/index.js +11 -0
  319. package/node_modules/upper-case-first/dist/index.js.map +1 -0
  320. package/node_modules/upper-case-first/dist/index.spec.d.ts +1 -0
  321. package/node_modules/upper-case-first/dist/index.spec.js +20 -0
  322. package/node_modules/upper-case-first/dist/index.spec.js.map +1 -0
  323. package/node_modules/upper-case-first/dist.es2015/index.d.ts +4 -0
  324. package/node_modules/upper-case-first/dist.es2015/index.js +7 -0
  325. package/node_modules/upper-case-first/dist.es2015/index.js.map +1 -0
  326. package/node_modules/upper-case-first/dist.es2015/index.spec.d.ts +1 -0
  327. package/node_modules/upper-case-first/dist.es2015/index.spec.js +18 -0
  328. package/node_modules/upper-case-first/dist.es2015/index.spec.js.map +1 -0
  329. package/node_modules/upper-case-first/package.json +87 -0
  330. package/package.json +181 -0
@@ -0,0 +1,37 @@
1
+ # Dot Case
2
+
3
+ [![NPM version][npm-image]][npm-url]
4
+ [![NPM downloads][downloads-image]][downloads-url]
5
+ [![Bundle size][bundlephobia-image]][bundlephobia-url]
6
+
7
+ > Transform into a lower case string with a period between words.
8
+
9
+ ## Installation
10
+
11
+ ```
12
+ npm install dot-case --save
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ ```js
18
+ import { dotCase } from "dot-case";
19
+
20
+ dotCase("string"); //=> "string"
21
+ dotCase("dot.case"); //=> "dot.case"
22
+ dotCase("PascalCase"); //=> "pascal.case"
23
+ dotCase("version 1.2.10"); //=> "version.1.2.10"
24
+ ```
25
+
26
+ The function also accepts [`options`](https://github.com/blakeembrey/change-case#options).
27
+
28
+ ## License
29
+
30
+ MIT
31
+
32
+ [npm-image]: https://img.shields.io/npm/v/dot-case.svg?style=flat
33
+ [npm-url]: https://npmjs.org/package/dot-case
34
+ [downloads-image]: https://img.shields.io/npm/dm/dot-case.svg?style=flat
35
+ [downloads-url]: https://npmjs.org/package/dot-case
36
+ [bundlephobia-image]: https://img.shields.io/bundlephobia/minzip/dot-case.svg
37
+ [bundlephobia-url]: https://bundlephobia.com/result?p=dot-case
@@ -0,0 +1,3 @@
1
+ import { Options } from "no-case";
2
+ export { Options };
3
+ export declare function dotCase(input: string, options?: Options): string;
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.dotCase = void 0;
4
+ var tslib_1 = require("tslib");
5
+ var no_case_1 = require("no-case");
6
+ function dotCase(input, options) {
7
+ if (options === void 0) { options = {}; }
8
+ return no_case_1.noCase(input, tslib_1.__assign({ delimiter: "." }, options));
9
+ }
10
+ exports.dotCase = dotCase;
11
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,mCAA0C;AAI1C,SAAgB,OAAO,CAAC,KAAa,EAAE,OAAqB;IAArB,wBAAA,EAAA,YAAqB;IAC1D,OAAO,gBAAM,CAAC,KAAK,qBACjB,SAAS,EAAE,GAAG,IACX,OAAO,EACV,CAAC;AACL,CAAC;AALD,0BAKC","sourcesContent":["import { noCase, Options } from \"no-case\";\n\nexport { Options };\n\nexport function dotCase(input: string, options: Options = {}) {\n return noCase(input, {\n delimiter: \".\",\n ...options,\n });\n}\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ var _1 = require(".");
4
+ var TEST_CASES = [
5
+ ["", ""],
6
+ ["test", "test"],
7
+ ["test string", "test.string"],
8
+ ["Test String", "test.string"],
9
+ ["dot.case", "dot.case"],
10
+ ["path/case", "path.case"],
11
+ ["TestV2", "test.v2"],
12
+ ["version 1.2.10", "version.1.2.10"],
13
+ ["version 1.21.0", "version.1.21.0"],
14
+ ];
15
+ describe("dot case", function () {
16
+ var _loop_1 = function (input, result) {
17
+ it(input + " -> " + result, function () {
18
+ expect(_1.dotCase(input)).toEqual(result);
19
+ });
20
+ };
21
+ for (var _i = 0, TEST_CASES_1 = TEST_CASES; _i < TEST_CASES_1.length; _i++) {
22
+ var _a = TEST_CASES_1[_i], input = _a[0], result = _a[1];
23
+ _loop_1(input, result);
24
+ }
25
+ });
26
+ //# sourceMappingURL=index.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.spec.js","sourceRoot":"","sources":["../src/index.spec.ts"],"names":[],"mappings":";;AAAA,sBAA4B;AAE5B,IAAM,UAAU,GAAuB;IACrC,CAAC,EAAE,EAAE,EAAE,CAAC;IACR,CAAC,MAAM,EAAE,MAAM,CAAC;IAChB,CAAC,aAAa,EAAE,aAAa,CAAC;IAC9B,CAAC,aAAa,EAAE,aAAa,CAAC;IAC9B,CAAC,UAAU,EAAE,UAAU,CAAC;IACxB,CAAC,WAAW,EAAE,WAAW,CAAC;IAC1B,CAAC,QAAQ,EAAE,SAAS,CAAC;IACrB,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;IACpC,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;CACrC,CAAC;AAEF,QAAQ,CAAC,UAAU,EAAE;4BACP,KAAK,EAAE,MAAM;QACvB,EAAE,CAAI,KAAK,YAAO,MAAQ,EAAE;YAC1B,MAAM,CAAC,UAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;;IAHL,KAA8B,UAAU,EAAV,yBAAU,EAAV,wBAAU,EAAV,IAAU;QAA7B,IAAA,qBAAe,EAAd,KAAK,QAAA,EAAE,MAAM,QAAA;gBAAb,KAAK,EAAE,MAAM;KAIxB;AACH,CAAC,CAAC,CAAC","sourcesContent":["import { dotCase } from \".\";\n\nconst TEST_CASES: [string, string][] = [\n [\"\", \"\"],\n [\"test\", \"test\"],\n [\"test string\", \"test.string\"],\n [\"Test String\", \"test.string\"],\n [\"dot.case\", \"dot.case\"],\n [\"path/case\", \"path.case\"],\n [\"TestV2\", \"test.v2\"],\n [\"version 1.2.10\", \"version.1.2.10\"],\n [\"version 1.21.0\", \"version.1.21.0\"],\n];\n\ndescribe(\"dot case\", () => {\n for (const [input, result] of TEST_CASES) {\n it(`${input} -> ${result}`, () => {\n expect(dotCase(input)).toEqual(result);\n });\n }\n});\n"]}
@@ -0,0 +1,3 @@
1
+ import { Options } from "no-case";
2
+ export { Options };
3
+ export declare function dotCase(input: string, options?: Options): string;
@@ -0,0 +1,7 @@
1
+ import { __assign } from "tslib";
2
+ import { noCase } from "no-case";
3
+ export function dotCase(input, options) {
4
+ if (options === void 0) { options = {}; }
5
+ return noCase(input, __assign({ delimiter: "." }, options));
6
+ }
7
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAW,MAAM,SAAS,CAAC;AAI1C,MAAM,UAAU,OAAO,CAAC,KAAa,EAAE,OAAqB;IAArB,wBAAA,EAAA,YAAqB;IAC1D,OAAO,MAAM,CAAC,KAAK,aACjB,SAAS,EAAE,GAAG,IACX,OAAO,EACV,CAAC;AACL,CAAC","sourcesContent":["import { noCase, Options } from \"no-case\";\n\nexport { Options };\n\nexport function dotCase(input: string, options: Options = {}) {\n return noCase(input, {\n delimiter: \".\",\n ...options,\n });\n}\n"]}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,24 @@
1
+ import { dotCase } from ".";
2
+ var TEST_CASES = [
3
+ ["", ""],
4
+ ["test", "test"],
5
+ ["test string", "test.string"],
6
+ ["Test String", "test.string"],
7
+ ["dot.case", "dot.case"],
8
+ ["path/case", "path.case"],
9
+ ["TestV2", "test.v2"],
10
+ ["version 1.2.10", "version.1.2.10"],
11
+ ["version 1.21.0", "version.1.21.0"],
12
+ ];
13
+ describe("dot case", function () {
14
+ var _loop_1 = function (input, result) {
15
+ it(input + " -> " + result, function () {
16
+ expect(dotCase(input)).toEqual(result);
17
+ });
18
+ };
19
+ for (var _i = 0, TEST_CASES_1 = TEST_CASES; _i < TEST_CASES_1.length; _i++) {
20
+ var _a = TEST_CASES_1[_i], input = _a[0], result = _a[1];
21
+ _loop_1(input, result);
22
+ }
23
+ });
24
+ //# sourceMappingURL=index.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.spec.js","sourceRoot":"","sources":["../src/index.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC;AAE5B,IAAM,UAAU,GAAuB;IACrC,CAAC,EAAE,EAAE,EAAE,CAAC;IACR,CAAC,MAAM,EAAE,MAAM,CAAC;IAChB,CAAC,aAAa,EAAE,aAAa,CAAC;IAC9B,CAAC,aAAa,EAAE,aAAa,CAAC;IAC9B,CAAC,UAAU,EAAE,UAAU,CAAC;IACxB,CAAC,WAAW,EAAE,WAAW,CAAC;IAC1B,CAAC,QAAQ,EAAE,SAAS,CAAC;IACrB,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;IACpC,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;CACrC,CAAC;AAEF,QAAQ,CAAC,UAAU,EAAE;4BACP,KAAK,EAAE,MAAM;QACvB,EAAE,CAAI,KAAK,YAAO,MAAQ,EAAE;YAC1B,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;;IAHL,KAA8B,UAAU,EAAV,yBAAU,EAAV,wBAAU,EAAV,IAAU;QAA7B,IAAA,qBAAe,EAAd,KAAK,QAAA,EAAE,MAAM,QAAA;gBAAb,KAAK,EAAE,MAAM;KAIxB;AACH,CAAC,CAAC,CAAC","sourcesContent":["import { dotCase } from \".\";\n\nconst TEST_CASES: [string, string][] = [\n [\"\", \"\"],\n [\"test\", \"test\"],\n [\"test string\", \"test.string\"],\n [\"Test String\", \"test.string\"],\n [\"dot.case\", \"dot.case\"],\n [\"path/case\", \"path.case\"],\n [\"TestV2\", \"test.v2\"],\n [\"version 1.2.10\", \"version.1.2.10\"],\n [\"version 1.21.0\", \"version.1.21.0\"],\n];\n\ndescribe(\"dot case\", () => {\n for (const [input, result] of TEST_CASES) {\n it(`${input} -> ${result}`, () => {\n expect(dotCase(input)).toEqual(result);\n });\n }\n});\n"]}
@@ -0,0 +1,89 @@
1
+ {
2
+ "name": "dot-case",
3
+ "version": "3.0.4",
4
+ "description": "Transform into a lower case string with a period between words",
5
+ "main": "dist/index.js",
6
+ "typings": "dist/index.d.ts",
7
+ "module": "dist.es2015/index.js",
8
+ "sideEffects": false,
9
+ "jsnext:main": "dist.es2015/index.js",
10
+ "files": [
11
+ "dist/",
12
+ "dist.es2015/",
13
+ "LICENSE"
14
+ ],
15
+ "scripts": {
16
+ "lint": "tslint \"src/**/*\" --project tsconfig.json",
17
+ "build": "rimraf dist/ dist.es2015/ && tsc && tsc -P tsconfig.es2015.json",
18
+ "specs": "jest --coverage",
19
+ "test": "npm run build && npm run lint && npm run specs",
20
+ "size": "size-limit",
21
+ "prepare": "npm run build"
22
+ },
23
+ "repository": {
24
+ "type": "git",
25
+ "url": "git://github.com/blakeembrey/change-case.git"
26
+ },
27
+ "keywords": [
28
+ "dot",
29
+ "case",
30
+ "period",
31
+ "full",
32
+ "stop",
33
+ "convert",
34
+ "transform"
35
+ ],
36
+ "author": {
37
+ "name": "Blake Embrey",
38
+ "email": "hello@blakeembrey.com",
39
+ "url": "http://blakeembrey.me"
40
+ },
41
+ "license": "MIT",
42
+ "bugs": {
43
+ "url": "https://github.com/blakeembrey/change-case/issues"
44
+ },
45
+ "homepage": "https://github.com/blakeembrey/change-case/tree/master/packages/dot-case#readme",
46
+ "size-limit": [
47
+ {
48
+ "path": "dist/index.js",
49
+ "limit": "450 B"
50
+ }
51
+ ],
52
+ "jest": {
53
+ "roots": [
54
+ "<rootDir>/src/"
55
+ ],
56
+ "transform": {
57
+ "\\.tsx?$": "ts-jest"
58
+ },
59
+ "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
60
+ "moduleFileExtensions": [
61
+ "ts",
62
+ "tsx",
63
+ "js",
64
+ "jsx",
65
+ "json",
66
+ "node"
67
+ ]
68
+ },
69
+ "publishConfig": {
70
+ "access": "public"
71
+ },
72
+ "dependencies": {
73
+ "no-case": "^3.0.4",
74
+ "tslib": "^2.0.3"
75
+ },
76
+ "devDependencies": {
77
+ "@size-limit/preset-small-lib": "^2.2.1",
78
+ "@types/jest": "^24.0.23",
79
+ "@types/node": "^12.12.14",
80
+ "jest": "^24.9.0",
81
+ "rimraf": "^3.0.0",
82
+ "ts-jest": "^24.2.0",
83
+ "tslint": "^5.20.1",
84
+ "tslint-config-prettier": "^1.18.0",
85
+ "tslint-config-standard": "^9.0.0",
86
+ "typescript": "^4.1.2"
87
+ },
88
+ "gitHead": "76a21a7f6f2a226521ef6abd345ff309cbd01fb0"
89
+ }
@@ -0,0 +1,15 @@
1
+ (The MIT License)
2
+
3
+ Copyright (c) 2011-2017 JP Richardson
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
6
+ (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
7
+ merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
8
+ furnished to do so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
11
+
12
+ THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
13
+ WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
14
+ OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
15
+ ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,262 @@
1
+ Node.js: fs-extra
2
+ =================
3
+
4
+ `fs-extra` adds file system methods that aren't included in the native `fs` module and adds promise support to the `fs` methods. It also uses [`graceful-fs`](https://github.com/isaacs/node-graceful-fs) to prevent `EMFILE` errors. It should be a drop in replacement for `fs`.
5
+
6
+ [![npm Package](https://img.shields.io/npm/v/fs-extra.svg)](https://www.npmjs.org/package/fs-extra)
7
+ [![License](https://img.shields.io/npm/l/fs-extra.svg)](https://github.com/jprichardson/node-fs-extra/blob/master/LICENSE)
8
+ [![build status](https://img.shields.io/github/workflow/status/jprichardson/node-fs-extra/Node.js%20CI/master)](https://github.com/jprichardson/node-fs-extra/actions/workflows/ci.yml?query=branch%3Amaster)
9
+ [![downloads per month](http://img.shields.io/npm/dm/fs-extra.svg)](https://www.npmjs.org/package/fs-extra)
10
+ [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
11
+
12
+ Why?
13
+ ----
14
+
15
+ I got tired of including `mkdirp`, `rimraf`, and `ncp` in most of my projects.
16
+
17
+
18
+
19
+
20
+ Installation
21
+ ------------
22
+
23
+ npm install fs-extra
24
+
25
+
26
+
27
+ Usage
28
+ -----
29
+
30
+ `fs-extra` is a drop in replacement for native `fs`. All methods in `fs` are attached to `fs-extra`. All `fs` methods return promises if the callback isn't passed.
31
+
32
+ You don't ever need to include the original `fs` module again:
33
+
34
+ ```js
35
+ const fs = require('fs') // this is no longer necessary
36
+ ```
37
+
38
+ you can now do this:
39
+
40
+ ```js
41
+ const fs = require('fs-extra')
42
+ ```
43
+
44
+ or if you prefer to make it clear that you're using `fs-extra` and not `fs`, you may want
45
+ to name your `fs` variable `fse` like so:
46
+
47
+ ```js
48
+ const fse = require('fs-extra')
49
+ ```
50
+
51
+ you can also keep both, but it's redundant:
52
+
53
+ ```js
54
+ const fs = require('fs')
55
+ const fse = require('fs-extra')
56
+ ```
57
+
58
+ Sync vs Async vs Async/Await
59
+ -------------
60
+ Most methods are async by default. All async methods will return a promise if the callback isn't passed.
61
+
62
+ Sync methods on the other hand will throw if an error occurs.
63
+
64
+ Also Async/Await will throw an error if one occurs.
65
+
66
+ Example:
67
+
68
+ ```js
69
+ const fs = require('fs-extra')
70
+
71
+ // Async with promises:
72
+ fs.copy('/tmp/myfile', '/tmp/mynewfile')
73
+ .then(() => console.log('success!'))
74
+ .catch(err => console.error(err))
75
+
76
+ // Async with callbacks:
77
+ fs.copy('/tmp/myfile', '/tmp/mynewfile', err => {
78
+ if (err) return console.error(err)
79
+ console.log('success!')
80
+ })
81
+
82
+ // Sync:
83
+ try {
84
+ fs.copySync('/tmp/myfile', '/tmp/mynewfile')
85
+ console.log('success!')
86
+ } catch (err) {
87
+ console.error(err)
88
+ }
89
+
90
+ // Async/Await:
91
+ async function copyFiles () {
92
+ try {
93
+ await fs.copy('/tmp/myfile', '/tmp/mynewfile')
94
+ console.log('success!')
95
+ } catch (err) {
96
+ console.error(err)
97
+ }
98
+ }
99
+
100
+ copyFiles()
101
+ ```
102
+
103
+
104
+ Methods
105
+ -------
106
+
107
+ ### Async
108
+
109
+ - [copy](docs/copy.md)
110
+ - [emptyDir](docs/emptyDir.md)
111
+ - [ensureFile](docs/ensureFile.md)
112
+ - [ensureDir](docs/ensureDir.md)
113
+ - [ensureLink](docs/ensureLink.md)
114
+ - [ensureSymlink](docs/ensureSymlink.md)
115
+ - [mkdirp](docs/ensureDir.md)
116
+ - [mkdirs](docs/ensureDir.md)
117
+ - [move](docs/move.md)
118
+ - [outputFile](docs/outputFile.md)
119
+ - [outputJson](docs/outputJson.md)
120
+ - [pathExists](docs/pathExists.md)
121
+ - [readJson](docs/readJson.md)
122
+ - [remove](docs/remove.md)
123
+ - [writeJson](docs/writeJson.md)
124
+
125
+ ### Sync
126
+
127
+ - [copySync](docs/copy-sync.md)
128
+ - [emptyDirSync](docs/emptyDir-sync.md)
129
+ - [ensureFileSync](docs/ensureFile-sync.md)
130
+ - [ensureDirSync](docs/ensureDir-sync.md)
131
+ - [ensureLinkSync](docs/ensureLink-sync.md)
132
+ - [ensureSymlinkSync](docs/ensureSymlink-sync.md)
133
+ - [mkdirpSync](docs/ensureDir-sync.md)
134
+ - [mkdirsSync](docs/ensureDir-sync.md)
135
+ - [moveSync](docs/move-sync.md)
136
+ - [outputFileSync](docs/outputFile-sync.md)
137
+ - [outputJsonSync](docs/outputJson-sync.md)
138
+ - [pathExistsSync](docs/pathExists-sync.md)
139
+ - [readJsonSync](docs/readJson-sync.md)
140
+ - [removeSync](docs/remove-sync.md)
141
+ - [writeJsonSync](docs/writeJson-sync.md)
142
+
143
+
144
+ **NOTE:** You can still use the native Node.js methods. They are promisified and copied over to `fs-extra`. See [notes on `fs.read()`, `fs.write()`, & `fs.writev()`](docs/fs-read-write-writev.md)
145
+
146
+ ### What happened to `walk()` and `walkSync()`?
147
+
148
+ They were removed from `fs-extra` in v2.0.0. If you need the functionality, `walk` and `walkSync` are available as separate packages, [`klaw`](https://github.com/jprichardson/node-klaw) and [`klaw-sync`](https://github.com/manidlou/node-klaw-sync).
149
+
150
+
151
+ Third Party
152
+ -----------
153
+
154
+ ### CLI
155
+
156
+ [fse-cli](https://www.npmjs.com/package/@atao60/fse-cli) allows you to run `fs-extra` from a console or from [npm](https://www.npmjs.com) scripts.
157
+
158
+ ### TypeScript
159
+
160
+ If you like TypeScript, you can use `fs-extra` with it: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fs-extra
161
+
162
+
163
+ ### File / Directory Watching
164
+
165
+ If you want to watch for changes to files or directories, then you should use [chokidar](https://github.com/paulmillr/chokidar).
166
+
167
+ ### Obtain Filesystem (Devices, Partitions) Information
168
+
169
+ [fs-filesystem](https://github.com/arthurintelligence/node-fs-filesystem) allows you to read the state of the filesystem of the host on which it is run. It returns information about both the devices and the partitions (volumes) of the system.
170
+
171
+ ### Misc.
172
+
173
+ - [fs-extra-debug](https://github.com/jdxcode/fs-extra-debug) - Send your fs-extra calls to [debug](https://npmjs.org/package/debug).
174
+ - [mfs](https://github.com/cadorn/mfs) - Monitor your fs-extra calls.
175
+
176
+
177
+
178
+ Hacking on fs-extra
179
+ -------------------
180
+
181
+ Wanna hack on `fs-extra`? Great! Your help is needed! [fs-extra is one of the most depended upon Node.js packages](http://nodei.co/npm/fs-extra.png?downloads=true&downloadRank=true&stars=true). This project
182
+ uses [JavaScript Standard Style](https://github.com/feross/standard) - if the name or style choices bother you,
183
+ you're gonna have to get over it :) If `standard` is good enough for `npm`, it's good enough for `fs-extra`.
184
+
185
+ [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
186
+
187
+ What's needed?
188
+ - First, take a look at existing issues. Those are probably going to be where the priority lies.
189
+ - More tests for edge cases. Specifically on different platforms. There can never be enough tests.
190
+ - Improve test coverage.
191
+
192
+ Note: If you make any big changes, **you should definitely file an issue for discussion first.**
193
+
194
+ ### Running the Test Suite
195
+
196
+ fs-extra contains hundreds of tests.
197
+
198
+ - `npm run lint`: runs the linter ([standard](http://standardjs.com/))
199
+ - `npm run unit`: runs the unit tests
200
+ - `npm test`: runs both the linter and the tests
201
+
202
+
203
+ ### Windows
204
+
205
+ If you run the tests on the Windows and receive a lot of symbolic link `EPERM` permission errors, it's
206
+ because on Windows you need elevated privilege to create symbolic links. You can add this to your Windows's
207
+ account by following the instructions here: http://superuser.com/questions/104845/permission-to-make-symbolic-links-in-windows-7
208
+ However, I didn't have much luck doing this.
209
+
210
+ Since I develop on Mac OS X, I use VMWare Fusion for Windows testing. I create a shared folder that I map to a drive on Windows.
211
+ I open the `Node.js command prompt` and run as `Administrator`. I then map the network drive running the following command:
212
+
213
+ net use z: "\\vmware-host\Shared Folders"
214
+
215
+ I can then navigate to my `fs-extra` directory and run the tests.
216
+
217
+
218
+ Naming
219
+ ------
220
+
221
+ I put a lot of thought into the naming of these functions. Inspired by @coolaj86's request. So he deserves much of the credit for raising the issue. See discussion(s) here:
222
+
223
+ * https://github.com/jprichardson/node-fs-extra/issues/2
224
+ * https://github.com/flatiron/utile/issues/11
225
+ * https://github.com/ryanmcgrath/wrench-js/issues/29
226
+ * https://github.com/substack/node-mkdirp/issues/17
227
+
228
+ First, I believe that in as many cases as possible, the [Node.js naming schemes](http://nodejs.org/api/fs.html) should be chosen. However, there are problems with the Node.js own naming schemes.
229
+
230
+ For example, `fs.readFile()` and `fs.readdir()`: the **F** is capitalized in *File* and the **d** is not capitalized in *dir*. Perhaps a bit pedantic, but they should still be consistent. Also, Node.js has chosen a lot of POSIX naming schemes, which I believe is great. See: `fs.mkdir()`, `fs.rmdir()`, `fs.chown()`, etc.
231
+
232
+ We have a dilemma though. How do you consistently name methods that perform the following POSIX commands: `cp`, `cp -r`, `mkdir -p`, and `rm -rf`?
233
+
234
+ My perspective: when in doubt, err on the side of simplicity. A directory is just a hierarchical grouping of directories and files. Consider that for a moment. So when you want to copy it or remove it, in most cases you'll want to copy or remove all of its contents. When you want to create a directory, if the directory that it's suppose to be contained in does not exist, then in most cases you'll want to create that too.
235
+
236
+ So, if you want to remove a file or a directory regardless of whether it has contents, just call `fs.remove(path)`. If you want to copy a file or a directory whether it has contents, just call `fs.copy(source, destination)`. If you want to create a directory regardless of whether its parent directories exist, just call `fs.mkdirs(path)` or `fs.mkdirp(path)`.
237
+
238
+
239
+ Credit
240
+ ------
241
+
242
+ `fs-extra` wouldn't be possible without using the modules from the following authors:
243
+
244
+ - [Isaac Shlueter](https://github.com/isaacs)
245
+ - [Charlie McConnel](https://github.com/avianflu)
246
+ - [James Halliday](https://github.com/substack)
247
+ - [Andrew Kelley](https://github.com/andrewrk)
248
+
249
+
250
+
251
+
252
+ License
253
+ -------
254
+
255
+ Licensed under MIT
256
+
257
+ Copyright (c) 2011-2017 [JP Richardson](https://github.com/jprichardson)
258
+
259
+ [1]: http://nodejs.org/docs/latest/api/fs.html
260
+
261
+
262
+ [jsonfile]: https://github.com/jprichardson/node-jsonfile