omni-file - npm Package Compare versions

Comparing version 1.3.1 to 1.3.2

dist/index.d.ts

@@ -76,6 +76,3 @@ /**
  * @example
- * {
- *   "js": "JavaScript",
- *   "py": "Python"
- * }
+ * { "js": "JavaScript", "py": "Python" }
  */
@@ -87,6 +84,3 @@ type ExtensionMapJSON = Record<string, string>;
  * @example
- * {
- *   "makefile": "Makefile",
- *   "Dockerfile": "Dockerfile"
- * }
+ * { "makefile": "Makefile", "Dockerfile": "Dockerfile" }
  */
@@ -133,3 +127,11 @@ type FileNamesMapJSON = Record<string, string>;
 
+/**
+ * The default icon set for dark themes.
+ * This constant contains all the icon definitions for files, folders, and languages.
+ */
 declare const icons: IconsJSON;
+/**
+ * The icon set for light themes.
+ * This constant contains all the icon definitions for files, folders, and languages optimized for light backgrounds.
+ */
 declare const iconsLight: IconsJSON;
@@ -166,4 +168,16 @@ /**
 
+/**
+ * A collection of language data, including icons, indexed by language name.
+ * This constant contains detailed information about various programming languages.
+ */
 declare const languages: LanguagesWithIconsJSON;
+/**
+ * A mapping of file extensions to language names.
+ * This constant is used to determine the language of a file based on its extension.
+ */
 declare const extensionMap: ExtensionMapJSON;
+/**
+ * A mapping of specific filenames to language names.
+ * This constant is used to determine the language of a file based on its exact filename.
+ */
 declare const fileNamesMap: FileNamesMapJSON;
@@ -170,0 +184,0 @@ /**

package.json

 {
   "name": "omni-file",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "You got a filename/foldername we got all its info: icon, category, type, extensions, mime type, color, and more...",
@@ -60,2 +60,4 @@ "homepage": "https://codyadam.github.io/omni-file/",
     "tsx": "^4.19.1",
+    "typedoc": "^0.26.8",
+    "typedoc-material-theme": "^1.1.0",
     "typescript": "^5.6.2",
@@ -68,4 +70,5 @@ "vitest": "^2.1.2"
     "test:coverage": "vitest run --coverage",
-    "update-data": "tsx scripts/run-all.ts"
+    "update-data": "tsx scripts/run-all.ts",
+    "docs": "typedoc"
   }
 }

README.md

@@ -6,3 +6,5 @@ # omni-file
 [![License](https://img.shields.io/github/license/CodyAdam/omni-file.svg)](https://github.com/CodyAdam/omni-file/blob/main/LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-online-blue.svg)](https://codyadam.github.io/omni-file/docs/index.html)
 
+
 Omni-file is a comprehensive file information extractor that provides language, icon, type, and MIME information for any file based on its name or extension. With **over 1000 icons**, support for **more than 700 programming languages**, and only **79.4 kB gzipped**, it's both **powerful and lightweight**!
@@ -132,32 +134,4 @@
 
-**Core functions:**
+[Documentation](https://codyadam.github.io/omni-file/docs/index.html)
 
-- `getLanguage(filename: string): Language`
-- `getIcon(filename: string, options?: IconOptions): string`
-
-**Utility functions:**
-
-- `getBaseFilenameFromRelativePath(filePath: string): string`
-- `getExtensionsFromRelativePath(filePath: string): string[]`
-
-**Type definitions:**
-
-- `LanguageData`: Detailed information about a programming language
-- `LanguageWithIconsData`: Extends `LanguageData` with icon information
-- `IconOptions`: Options for icon retrieval (isFolder, isExpanded, isLight)
-
-- `LanguagesJSON`: A record of language names to `LanguageData` objects
-- `LanguagesWithIconsJSON`: A record of language names to `LanguageWithIconsData` objects
-- `ExtensionMapJSON`: Maps file extensions to language names
-- `FileNamesMapJSON`: Maps specific filenames to language names
-- `IconsJSON`: Defines icon associations for files and folders
-
-**Raw data:**
-
-- [`languages`](https://github.com/CodyAdam/omni-file/tree/main/src/data/languages-with-icons.json): A map of all languages with icons
-- [`extensionMap`](https://github.com/CodyAdam/omni-file/tree/main/src/data/extension-map.json): Maps file extensions to language names
-- [`fileNamesMap`](https://github.com/CodyAdam/omni-file/tree/main/src/data/file-names-map.json): Maps specific filenames to language names
-- [`icons`](https://github.com/CodyAdam/omni-file/tree/main/src/data/icons.json): Default icon set (dark theme)
-- [`iconsLight`](https://github.com/CodyAdam/omni-file/tree/main/src/data/icons-light.json): Light theme icon set (has less icons then dark theme)
-
 ## Icon Themes
@@ -164,0 +138,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1757717

increased by0.01%

Lines of code

3465

increased by0.41%

Worsened metrics

Dev dependency count

11

increased by22.22%

Number of lines in readme file

200

decreased by-11.5%

No dependency changes