feat(project): setup lib

paztek · Dec 8, 2023 · 2b76927 · 2b76927
1 parent 18df7c7
commit 2b76927
Show file tree

Hide file tree

Showing 35 changed files with 6,570 additions and 5,853 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -5,9 +5,9 @@ root = true
 
 # Settings for any file.
 [*]
-  charset = utf-8
-  end_of_line = lf
-  indent_size = 2
-  indent_style = space
-  insert_final_newline = true
-  trim_trailing_whitespace = true
+    charset = utf-8
+    end_of_line = lf
+    indent_size = 4
+    indent_style = space
+    insert_final_newline = true
+    trim_trailing_whitespace = true
diff --git a/.gitignore b/.gitignore
@@ -28,3 +28,7 @@ pnpmfile.js
 # Log files.
 *.log
 *.log.*
+
+# env files
+.env
+!.env.example
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/.idea/llobotomy-azure.iml b/.idea/llobotomy-azure.iml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/runConfigurations/build.xml b/.idea/runConfigurations/build.xml
diff --git a/.idea/runConfigurations/doc.xml b/.idea/runConfigurations/doc.xml
diff --git a/.idea/runConfigurations/lint.xml b/.idea/runConfigurations/lint.xml
diff --git a/.idea/runConfigurations/lint_fix.xml b/.idea/runConfigurations/lint_fix.xml
diff --git a/.idea/runConfigurations/prepublishOnly.xml b/.idea/runConfigurations/prepublishOnly.xml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [year] [authorFullName]
+Copyright (c) 2023 Matthieu Balmes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,20 +1,20 @@
-# [libraryNameWithSpacesAndUpperCases]
+# LLobotoMy for Azure
 
-[![Continuous Integrations](https://github.com/[repositoryOwner]/[repositoryName]/actions/workflows/continuous-integrations.yaml/badge.svg?branch=main)](https://github.com/[repositoryOwner]/[repositoryName]/actions/workflows/continuous-integrations.yaml)
-[![License](https://badgen.net/github/license/[repositoryOwner]/[repositoryName])](./LICENSE)
-[![Package tree-shaking](https://badgen.net/bundlephobia/tree-shaking/[libraryName])](https://bundlephobia.com/package/[libraryName])
-[![Package minified & gzipped size](https://badgen.net/bundlephobia/minzip/[libraryName])](https://bundlephobia.com/package/[libraryName])
-[![Package dependency count](https://badgen.net/bundlephobia/dependency-count/react[libraryName])](https://bundlephobia.com/package/[libraryName])
+[![Continuous Integrations](https://github.com/paztek/llobotomy-azure/actions/workflows/continuous-integrations.yaml/badge.svg?branch=main)](https://github.com/paztek/llobotomy-azure/actions/workflows/continuous-integrations.yaml)
+[![License](https://badgen.net/github/license/paztek/llobotomy-azure)](./LICENSE)
+[![Package tree-shaking](https://badgen.net/bundlephobia/tree-shaking/llobotomy-azure)](https://bundlephobia.com/package/llobotomy-azure)
+[![Package minified & gzipped size](https://badgen.net/bundlephobia/minzip/llobotomy-azure)](https://bundlephobia.com/package/llobotomy-azure)
+[![Package dependency count](https://badgen.net/bundlephobia/dependency-count/reactllobotomy-azure)](https://bundlephobia.com/package/llobotomy-azure)
 
 ## Installation
 
 This library is published in the NPM registry and can be installed using any compatible package manager.
 
 ```sh
-npm install [libraryName] --save
+npm install llobotomy-azure --save
 
 # For Yarn, use the command below.
-yarn add [libraryName]
+yarn add llobotomy-azure
 ```
 
 ### Installation from CDN
@@ -23,14 +23,14 @@ This module has an UMD bundle available through JSDelivr and Unpkg CDNs.
 
 ```html
 <!-- For UNPKG use the code below. -->
-<script src="https://unpkg.com/[libraryName]"></script>
+<script src="https://unpkg.com/llobotomy-azure"></script>
 
 <!-- For JSDelivr use the code below. -->
-<script src="https://cdn.jsdelivr.net/npm/[libraryName]"></script>
+<script src="https://cdn.jsdelivr.net/npm/llobotomy-azure"></script>
 
 <script>
-  // UMD module is exposed through the "[libraryCamelCaseName]" global variable.
-  console.log([libraryCamelCaseName]);
+  // UMD module is exposed through the "llobotomy-azure" global variable.
+  console.log(llobotomy-azure);
 </script>
 ```
 

diff --git a/dist/index.cjs b/dist/index.cjs
@@ -1,6 +1,6 @@
 /*!
- * [libraryName] v0.0.0
- * (c) [authorFullName]
+ * llobotomy-azure v0.0.0
+ * (c) Matthieu Balmes
  * Released under the MIT License.
  */
 

diff --git a/dist/index.cjs.map b/dist/index.cjs.map
diff --git a/dist/index.esm.js b/dist/index.esm.js
diff --git a/dist/index.esm.js.map b/dist/index.esm.js.map
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/index.mjs b/dist/index.mjs
@@ -1,6 +1,6 @@
 /*!
- * [libraryName] v0.0.0
- * (c) [authorFullName]
+ * llobotomy-azure v0.0.0
+ * (c) Matthieu Balmes
  * Released under the MIT License.
  */
 

diff --git a/dist/index.mjs.map b/dist/index.mjs.map
diff --git a/dist/index.umd.js b/dist/index.umd.js
diff --git a/dist/index.umd.min.js b/dist/index.umd.min.js
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
-[libraryNameWithSpacesAndUpperCases]
+LLobotoMy for Azure
 
-# [libraryNameWithSpacesAndUpperCases]
+# LLobotoMy for Azure
 
 ## Table of contents
 
@@ -22,7 +22,7 @@ A Branded Type for values parseable to number.
 
 #### Defined in
 
-[index.ts:4](https://github.com/VitorLuizC/typescript-library-boilerplate/blob/c48c9c1/src/index.ts#L4)
+[index.ts:4](https://github.com/paztek/llobotomy-azure/blob/18df7c7/src/index.ts#L4)
 
 ## Functions
 
@@ -58,4 +58,4 @@ return Number(value);
 
 #### Defined in
 
-[index.ts:24](https://github.com/VitorLuizC/typescript-library-boilerplate/blob/c48c9c1/src/index.ts#L24)
+[index.ts:24](https://github.com/paztek/llobotomy-azure/blob/18df7c7/src/index.ts#L24)
diff --git a/jest.config.js b/jest.config.js
@@ -6,16 +6,16 @@
  * @type {import('ts-jest').JestConfigWithTsJest}
  */
 const options = {
-  transform: {
-    '^.+\\.tsx?$': [
-      'ts-jest',
-      {
-        isolatedModules: true,
-        useESM: true
-      },
-    ],
-  },
-  resolver: 'ts-jest-resolver'
+    transform: {
+        '^.+\\.tsx?$': [
+            'ts-jest',
+            {
+                isolatedModules: true,
+                useESM: true
+            },
+        ],
+    },
+    resolver: 'ts-jest-resolver'
 };
 
 module.exports = options;