update tsconfig

2024-04-14 17:59:06 +02:00 · 2024-04-14 17:59:06 +02:00 · 70dc0ef68f
commit 70dc0ef68f
parent 1e13cc76be
4 changed files with 111 additions and 31 deletions
--- a/npmextra.json
+++ b/npmextra.json
@ -5,17 +5,26 @@
      "githost": "code.foss.global",
      "gitscope": "push.rocks",
      "gitrepo": "smartmime",
-      "description": "a module to detect mime types",
+      "description": "A module for detecting MIME types with support for binary and text file distinctions.",
      "npmPackagename": "@push.rocks/smartmime",
      "license": "MIT",
-      "projectDomain": "push.rocks"
+      "projectDomain": "push.rocks",
+      "keywords": [
+        "MIME type detection",
+        "file type identification",
+        "node.js",
+        "binary files",
+        "text files",
+        "file encoding",
+        "mime types library"
+      ]
    }
  },
  "npmci": {
    "npmGlobalTools": [],
    "npmAccessLevel": "public"
  },
-  "tsdocs": {
+  "tsdoc": {
    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
  }
 }
--- a/package.json
+++ b/package.json
@ -2,7 +2,7 @@
  "name": "@push.rocks/smartmime",
  "version": "1.0.6",
  "private": false,
-  "description": "a module to detect mime types",
+  "description": "A module for detecting MIME types with support for binary and text file distinctions.",
  "main": "dist_ts/index.js",
  "typings": "dist_ts/index.d.ts",
  "author": "Lossless GmbH",
@ -40,5 +40,14 @@
  "browserslist": [
    "last 1 chrome versions"
  ],
-  "type": "module"
+  "type": "module",
+  "keywords": [
+    "MIME type detection",
+    "file type identification",
+    "node.js",
+    "binary files",
+    "text files",
+    "file encoding",
+    "mime types library"
+  ]
 }
--- a/readme.hints.md
+++ b/readme.hints.md
@ -0,0 +1 @@
+ 
--- a/readme.md
+++ b/readme.md
@ -1,37 +1,98 @@
 # @push.rocks/smartmime
 a module to detect mime types

-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartmime)
-* [gitlab.com (source)](https://gitlab.com/push.rocks/smartmime)
-* [github.com (source mirror)](https://github.com/push.rocks/smartmime)
-* [docs (typedoc)](https://push.rocks.gitlab.io/smartmime/)
+## Install
+Installing `@push.rocks/smartmime` is as simple as running the following npm command in your terminal. Make sure you have Node.js (version 10.x or newer) installed on your machine.

-## Status for master
+```bash
+npm install @push.rocks/smartmime --save
+```

-Status Category | Status Badge
-- | --
-GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartmime/badges/master/pipeline.svg)](https://lossless.cloud)
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartmime/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartmime)](https://lossless.cloud)
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/smartmime)](https://lossless.cloud)
-TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
-node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
-PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartmime)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartmime)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartmime)](https://lossless.cloud)
+This command will download `@push.rocks/smartmime` and add it to your project's `package.json` file.

 ## Usage

-Use TypeScript for best in class intellisense
+`@push.rocks/smartmime` is a versatile TypeScript module designed for mime type detection, supporting a variety of file types including images (JPG, PNG), text (HTML, SVG), application data (JSON), and scripts (TS, JS). Utilizing ESM syntax, this guide demonstrates its comprehensive feature set.

-## Contribution
+### Basic Mime Type Detection

-We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+To start, you can use the `detectMimeType` function to analyze a file path and return its mime type. Supported mime types include `image/jpeg`, `image/svg+xml`, `application/json`, `text/html`, etc.

-For further information read the linked docs at the top of this readme.
+```typescript
+import { detectMimeType } from '@push.rocks/smartmime';

-## Legal
-> MIT licensed | **&copy;** [Task Venture Capital GmbH](https://task.vc)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+// Example: Detecting the mime type of a JPEG image
+const imagePath = 'path/to/image.jpg';
+const imageMimeType = detectMimeType(imagePath);
+console.log(imageMimeType); // Output: 'image/jpeg'
+
+// Example: Detecting the mime type of an SVG
+const svgPath = 'path/to/design.svg';
+const svgMimeType = detectMimeType(svgPath);
+console.log(svgMimeType); // Output: 'image/svg+xml'
+```
+
+### Checking if a File is Binary
+
+Determining whether a file is binary (e.g., images, PDFs) or text-based (e.g., HTML, TypeScript) is crucial for data handling. The `isBinary` function facilitates this by returning a boolean value.
+
+```typescript
+import { isBinary } from '@push.rocks/smartmime';
+
+// Example: Checking if a PNG image is binary
+const binaryCheckPath = 'path/to/image.png';
+console.log(isBinary(binaryCheckPath)); // Output: true
+
+// Example: Checking if a CSS file is binary
+const cssPath = 'path/to/styles.css';
+console.log(isBinary(cssPath)); // Output: false
+```
+
+### Getting File Encoding
+
+Knowing a file's encoding is essential for reading or writing operations. The `getEncoding` function returns 'binary' for binary files and 'utf8' for text-based files.
+
+```typescript
+import { getEncoding } from '@push.rocks/smartmime';
+
+// Example: Getting encoding for a PDF document
+const pdfPath = 'path/to/document.pdf';
+console.log(getEncoding(pdfPath)); // Output: 'binary'
+
+// Example: Getting encoding for a JavaScript file
+const scriptPath = 'path/to/script.js';
+console.log(getEncoding(scriptPath)); // Output: 'utf8'
+```
+
+### Supported File Types
+
+`@push.rocks/smartmime` has predefined support for a select list of binary and text file types, including JSON, HTML, SVG, JPG, TS, and JS. This predefined list ensures quick integration for common file handling scenarios, but the library's core functions can be leveraged for a broader set of file types as it relies on the comprehensive `mime-types` library for mime type detection.
+
+### Advanced Usage
+
+Given the modular and straightforward design of `@push.rocks/smartmime`, it is seamlessly integrable into file processing pipelines, web server implementations, or any application requiring mime type detection. Its functionality extends beyond simple file type checking, allowing for sophisticated file type validations, content-based routing, or conditional processing based on detected mime types.
+
+By utilizing TypeScript, `@push.rocks/smartmime` not only offers strong typing advantages for development time introspection but also ensures compatibility with modern JavaScript projects taking advantage of ES modules.
+
+### Conclusion
+
+`@push.rocks/smartmime` encapsulates a powerful set of functionalities for mime type detection, addressing common needs in file handling with an easy-to-use API. Whether for basic checks or integrated into larger processing pipelines, it stands as a valuable tool for developers needing reliable mime type detection in their Node.js or TypeScript projects.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.