Qol updates

.github/ISSUE_TEMPLATE/1-feature_request.yml

@@ -0,0 +1,28 @@
+name: Feature Request
+description: Suggest an idea for Chomp!
+title: 'Suggestion: '
+body:
+  - type: textarea
+    attributes:
+      label: Tell us what problem the feature would solve
+      description: Provide as much information as possible and please be descriptive.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Did you consider any alternatives? If so, why is this the best?
+      description: A clear and concise description of any alternative solutions or features you've considered but why you've picked this one.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional Info
+      description: If applicable, add any other context or screenshots about the feature request here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/2-bug_report.yml

@@ -0,0 +1,46 @@
+name: Bug Report
+description: File a bug report.
+title: "Bug: "
+body:
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Provide as much information as possible and please be descriptive.
+    validations:
+      required: true
+  - type: dropdown
+    id: runtime
+    attributes:
+      label: Runtime
+      description: What runtime (Node, Deno, etc) are you using?
+      options:
+        - Deno
+        - NodeJS
+        - Bun
+        - Other (add the name to the version)
+      default: 0
+    validations:
+      required: true
+  - type: input
+    id: runtime-version
+    attributes:
+      label: Runtime Version
+      description: What version of the runtime are you using? In Deno you could get this through `deno --version`.
+      placeholder: 1.46.3
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+  - type: checkboxes
+    id: latest
+    attributes:
+      label: Latest Release
+      description: By submitting this issue, you confirm that you are using the latest release when this issue is present.
+      options:
+        - label: I confirm that I am running on the latest release.
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/pull_request_template.md

@@ -0,0 +1,27 @@
+### What changes are being made
+<!-- Give examples of the changes you've made in the PR. Itemized lists are preferred -->
+
+- [INSERT CHANGE HERE]
+
+### What is the context?
+<!-- Is there any context like issues for this PR? -->
+
+I made this PR because ...
+
+### Some checks you should make
+<!-- This checklist must all be finished before we can merge it -->
+
+- [ ] You have no left-over console logs.
+- [ ] You have no left-over debuggers.
+- [ ] You have no left-over other pieces or code.
+- [ ] You have kept the documentation in-sync with the code as much as possible.
+- [ ] You have nothing to add after taking a break and coming in cold.
+
+### Some checks we should make
+<!-- This checklist is for reviewers, you can ignore it -->
+
+- [ ] Changes have no left-over console logs.
+- [ ] Changes have no left-over debuggers.
+- [ ] Changes have no left-over "other pieces or code".
+- [ ] Changes have kept the documentation in-sync with the code as much as possible.
+- [ ] Changes still look good after taking a break and coming in cold.

.github/workflows/test.yml

@@ -0,0 +1,53 @@
+name: Tests
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+  #chomp-format:
+  #  runs-on: ubuntu-latest
+  #  steps:
+  #    - name: Clone repository
+  #      uses: actions/checkout@v3
+  #      with:
+  #        submodules: true
+  #    - name: Set up Deno
+  #      uses: denoland/setup-deno@v1
+  #      with:
+  #        deno-version: "1.40.0"
+  #    - name: Check format
+  #      run: deno fmt --check
+  #chomp-lint:
+  #  runs-on: ubuntu-latest
+  #  steps:
+  #    - name: Clone repository
+  #      uses: actions/checkout@v3
+  #      with:
+  #        submodules: true
+  #    - name: Set up Deno
+  #      uses: denoland/setup-deno@v1
+  #      with:
+  #        deno-version: "1.40.0"
+  #    - name: Check lint
+  #      run: deno lint
+  chomp-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+      - name: Set up Deno
+        uses: denoland/setup-deno@v1
+        with:
+          deno-version: "1.40.0"
+      - name: Run tests generating coverage
+        run: deno task test:coverage
+      - name: Generate lcov report
+        run: deno task coverage > cov.lcov
+      - name: upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./cov.lcov
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,2 +1,9 @@
 # Ignore IDE-specific folders
 /.idea
+
+# Ignore reports
+/cov
+/cov.lcov
+
+# Ignore docs
+/src/docs

.run/Deno_ Test.run.xml

@@ -0,0 +1,5 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Deno: Test" type="DenoConfigurationType" inputPath="." programParameters="run test">
+    <method v="2" />
+  </configuration>
+</component>

README.md

@@ -1,25 +1,66 @@
 # Chomp
-Library of (arguably) useful Deno classes.  
-Should work just fine but comes with no warranties whatsoever.  
+
+Library of (arguably) useful stuff.  
+This library prioritizes "ease of use" over "efficiency".  
+
+Should work just fine but comes with no warranties whatsoever.
 
 ## Usage
-Add the following to your file:
+
+Chomp is structured in such a way that you can import just what you need for your app.\
+A good start would be to import the most common things you might use:
+
 ```ts
-import * from "https://deno.land/x/chomp/mod.ts";
+import * from "https://deno.land/x/chomp/common.ts";
 ```
 
-That's it!  
-You can visit the [documentation](https://doc.deno.land/https://deno.land/x/chomp/mod.ts) to see what Chomp is capable off!  
-Someday I'll write a better usage guide.
+This includes (list might not always be up-to-date):
+
+- [Cache](docs/core/cache.md)
+- [Configure](docs/core/configure.md)
+- [Logger](docs/logging/logger.md)
+- [File](docs/filesystem/file.md)
+- [Folder](docs/filesystem/folder.md)
+- [CheckSource](docs/utility/check-source.md)
+
+However, there are many more things included so feel free to explore the [docs](/docs) or [Deno.land](https://doc.deno.land/https://deno.land/x/chomp/mod.ts)
+to see what more Chomp is capable off!
+
+**NOTE**: While you can import `https://deno.land/x/chomp/mod.ts`, I advice against this as it'll load the entire
+codebase, including stuff you may not actually be using.
+
+### Configuration keys
+
+While Chomp does try to have a lot of "good enough" defaults, sometimes you may want to set things to your own needs.  
+As a result, some things can be configured by you by adding entries to the Configure.
+
+| Key | Default Value | Comment                                                                                                                             |
+|-----|---------------|-------------------------------------------------------------------------------------------------------------------------------------|
+| `chomp_optimistic_delay` | `'+1 hour'` | Additional time a cache entry may exist for optimistic caching. Uses the `utility/time-string` formats                              |
+| `chomp_couchdb_cache` | `'+1 hour'` | Time a document for `communication/couchdb` will be kept in the cache to improve read times. Uses the `utility/time-string` formats |
+ | `log_level` | `1.0` | Bitmask for the enabled log levels.                                                                                                 |
+
+### Extensions
+
+Chomp includes a few "extensions" that _modify JavaScript's built-in prototypes_.  
+Most of these should be free from interference unless you use other libraries that do this.  
+You can load extensions by simply including them into your project.  
+
+```ts
+import "https://deno.land/x/chomp/extensions/date/is-before.ts";
+```
 
+## Versioning
 
-## Compatibility
-Below a chart indicating for which Deno version this library is built and tested.  
-Compatibility may be more flexible, however, chances are this library may not work with older of newer versions than indicated.
+As of `?.0.0.0-0`, versioning adheres to the following versioning system of `a.b.c.d-e` where:
 
-| Library Version | Deno Version |
-|-----------------|--------------|
-| 1.1.0           | 1.24.0       |
-| 1.0.0           | 1.15.3       |
-| 0.0.2           | ???          |
-| 0.0.1           | ???          |
+- `a`: Some previous behaviour may have changed in a non-backwards compatible fashion (breaking).
+  - Impact: Serious updates may be required on your end.
+- `b`: All previous deprecations were removed (potentially breaking).
+  - Impact: Nothing if you kept up with deprecations.
+- `c`: Deprecations were added in this release.
+  - Impact: Deprecations may need to be fixed on your end.
+- `d`: New feature(s) were added.
+  - Impact: New goodies for you to use.
+- `e`: Small fixes (typo's, bugs, documentation etc.)
+  - Impact: Generally none.

benchmarks/202512220028_hex-encode-std.ts

@@ -0,0 +1,31 @@
+import { encodeHex as std } from "jsr:@std/encoding@1.0.10";
+import { Random } from "../src/security/random.ts";
+
+// Generate dataset
+const dataset: Uint8Array[] = [];
+for(let i = 0; i < 10_000; i++) {
+  dataset.push(Random.bytes(128));
+}
+
+/**
+ * Old hex encoding function
+ *
+ * @param input
+ */
+function old(input: Uint8Array): string {
+  return [...new Uint8Array(input)].map((x) => x.toString(16).padStart(2, "0")).join("");
+}
+
+
+Deno.bench("Old Method", () => {
+  for(const entry of dataset) {
+    old(entry);
+  }
+});
+
+Deno.bench("Standard Library", () => {
+  for(const entry of dataset) {
+    std(entry);
+  }
+});
+

common.ts

@@ -0,0 +1,8 @@
+/**
+ * These are just the exports you'll most commonly use.
+ * You can view the "docs"-directory to see what else there is!
+ */
+export { Cache, Configure, Logger } from "./src/core/mod.ts";
+export { File } from "./src/filesystem/file.ts";
+export { Folder } from "./src/filesystem/folder.ts";
+export { CheckSource } from "./src/utility/check-source.ts";