Neoclassical Programming Multitude

    @allmarkedup/fang

    2.0.0 • Public • Published

    Fang

    A tiny utility to get language information about a file.

    Simply checks the file extension against Github's list of known languages. If you need something more robust (but likely slower) then other solutions are available :-)

    Installation

    $ npm install @allmarkedup/fang --save

    Usage

    The fang module exports a single function with the following signature:

    fang(<path-to-file>);

    And returns and object with known information about the language, or undefined if not recognised). For example:

    const fang = require('@allmarkedup/fang');
    
    console.dir(fang('assets/styles/main.scss'));
    
    // Outputs:
    // {
    //     "name":  "SCSS",           // Language name
    //     "type": "programming",     // language type - programming, data, markup etc
    //     "color": "#CF649A",        // Github UI color
    //     "extensions": [".scss"],   // Array of known extensions
    //     "aliases": [],             // Array of known aliases
    //     "language_id": 32,         // Github language ID
    // }

    Credits

    All language information is taken from Github's Linguist gem.

    Keywords

    none

    Install

    npm i @allmarkedup/fang

    DownloadsWeekly Downloads

    9,113

    Version

    2.0.0

    License

    MIT

    Last publish

    Collaborators

    • allmarkedup