file-lang-map 1.1.0 → 1.1.2

package/README.md

@@ -1,22 +1,22 @@
 # file-lang-map
 
-**Fast, zero-dependency way to identify programming languages from filenames and extensions.**
+**Fast, zero-dependency way to identify programming languages from paths, filenames, and extensions.**
 
 ## Why
 
-Most language detection libraries are either too heavy or too slow (looping over arrays).
-`file-lang-map` pre-indexes GitHub
-Linguist [languages.yml](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml) data into optimized
-hash maps, ensuring instant lookups with a tiny footprint.
+Some language detectors can be heavy or rely on linear scans. `file-lang-map` pre-indexes GitHub
+Linguist [languages.yml](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml) into compact lookup
+maps, giving near-instant lookups, a small bundle size, and zero runtime dependencies.
 
 ## Features
 
-- **O(1) Performance:** Lookups are instant, regardless of how many languages exist.
-- **Browser Ready:** Zero dependencies (no `fs`, no `path`). Works in browser and Node.js.
+- **O(1) (average-case) Performance:** Lookups are instant, regardless of how many languages exist.
+- **Browser Ready:** Zero runtime dependencies. Works in browser and Node.js.
 - **TypeScript Support:** Includes built-in type definitions.
+- **Flexible:** Works with full and relative paths, filenames, or just extensions for all platforms.
+- **Tiny:** Tree-shakable. Only load what you use. (Use named imports and a bundler that supports tree-shaking)
 - **Collision Aware:** Correctly handles ambiguous extensions (e.g., `.h` returns "C", "C++" and "Objective-C").
-- **Auto-Updated:** Data is fetched directly from GitHub Linguist sources.
-- **Tiny:** Tree-shakable. Only load what you use.
+- **Auto-Updated:** Data is fetched directly from GitHub Linguist sources using GitHub actions weekly.
 
 ## Installation
 
@@ -24,11 +24,45 @@ hash maps, ensuring instant lookups with a tiny footprint.
 npm install file-lang-map
 ```
 
-## Usage
+## Quick Start
+
+```typescript
+import {getLanguageByFileName, getLanguage, getLanguagesByType} from 'file-lang-map';
+
+// Get all possible languages from filename (may return null if unknown)
+const languages = getLanguageByFileName('path/to/file.js');
+if (languages === null) {
+  console.log('not found')
+} else {
+  console.log(languages)
+  // ['JavaScript']
+}
+
+// Get language metadata by name. Case-insensitive lookup ("javascript" or "JavaScript").
+const language = getLanguage('JavaScript');
+/*
+{
+  name: 'JavaScript',
+  type: 'programming',
+  extensions: ['.js', '.cjs', '.mjs', ... ], // list of all know extensions
+  filenames: ['Jakefile'] // list of all known filenames
+}
+*/
+
+// You can optionally filter results by type (e.g., only 'programming')
+const prog = getLanguageByFileName('data.json', 'programming');
+// prog === null because JSON is a 'data' type
+
+// Get list of all known "programming" languages (also available - 'data', 'markup', 'prose')
+const programmingLanguages = getLanguagesByType('programming');
+// ['JavaScript', 'Python', 'TypeScript', 'Rust', ...]
+```
+
+## Examples
 
 ### 1. Identify Language by Filename
 
-Handles full paths, exact filenames, and extensions. Returns an array of language names.
+Handles full paths (absolute or relative), exact filenames, and extensions. Returns an array of language names.
 
 ```typescript
 import {getLanguageByFileName} from 'file-lang-map';
@@ -67,10 +101,13 @@ const json = getLanguageByFileName('data.json', 'programming');
 ### 3. Get Language Metadata
 
 Lookup full language details by name (case-insensitive).
+Language object includes all possible extensions for the language, name, possible filenames, and type.
 
 ```typescript
 import {getLanguage} from 'file-lang-map';
 
+// Case-insensitive lookup. 
+// Returns language object which includes all possible extensions for the language, name...
 const lang = getLanguage('javascript');
 /*
 {

package/dist/index.js

@@ -2379,6 +2379,9 @@ var extensions_default = {
   ".pat": [
     "max"
   ],
+  ".metta": [
+    "metta"
+  ],
   ".moo": [
     "mercury",
     "moocode"
@@ -4775,6 +4778,9 @@ var filenames_default = {
   Cask: [
     "emacs lisp"
   ],
+  Eask: [
+    "emacs lisp"
+  ],
   "Project.ede": [
     "emacs lisp"
   ],
@@ -7518,6 +7524,7 @@ var languages_default = {
       ".spacemacs",
       ".viper",
       "Cask",
+      "Eask",
       "Project.ede",
       "_emacs",
       "abbrev_defs"
@@ -9720,6 +9727,14 @@ var languages_default = {
     ],
     filenames: []
   },
+  metta: {
+    name: "MeTTa",
+    type: "programming",
+    extensions: [
+      ".metta"
+    ],
+    filenames: []
+  },
   mercury: {
     name: "Mercury",
     type: "programming",
@@ -14124,6 +14139,7 @@ var types_default = {
     "Mako",
     "Mathematical Programming System",
     "Max",
+    "MeTTa",
     "Mercury",
     "Meson",
     "Metal",

package/dist/index.mjs

@@ -2351,6 +2351,9 @@ var extensions_default = {
   ".pat": [
     "max"
   ],
+  ".metta": [
+    "metta"
+  ],
   ".moo": [
     "mercury",
     "moocode"
@@ -4747,6 +4750,9 @@ var filenames_default = {
   Cask: [
     "emacs lisp"
   ],
+  Eask: [
+    "emacs lisp"
+  ],
   "Project.ede": [
     "emacs lisp"
   ],
@@ -7490,6 +7496,7 @@ var languages_default = {
       ".spacemacs",
       ".viper",
       "Cask",
+      "Eask",
       "Project.ede",
       "_emacs",
       "abbrev_defs"
@@ -9692,6 +9699,14 @@ var languages_default = {
     ],
     filenames: []
   },
+  metta: {
+    name: "MeTTa",
+    type: "programming",
+    extensions: [
+      ".metta"
+    ],
+    filenames: []
+  },
   mercury: {
     name: "Mercury",
     type: "programming",
@@ -14096,6 +14111,7 @@ var types_default = {
     "Mako",
     "Mathematical Programming System",
     "Max",
+    "MeTTa",
     "Mercury",
     "Meson",
     "Metal",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "file-lang-map",
-  "version": "1.1.0",
-  "description": "Identify programming languages from filenames and extensions.",
+  "version": "1.1.2",
+  "description": "Identify programming languages from paths, filenames and extensions.",
   "keywords": [
     "linguist",
     "detect-language",