2.1.0

changelog.md

@@ -1,6 +1,7 @@
 # Changelog
 
-## Next
+## 2.1.0
+*2021-09-11*
 - Added nullable `parent` property to each entry in `languages.results` to display the parent language.
 - Added option `childLanguages` to control whether child languages are displayed instead of their parent (defaults to `false`).
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linguist-js",
-	"version": "2.0.3",
+	"version": "2.1.0",
 	"description": "Analyse languages used in a folder. Powered by GitHub Linguist, although it doesn't need to be installed.",
 	"main": "dist/index.js",
 	"bin": {
@@ -11,6 +11,7 @@
 	},
 	"scripts": {
 		"prepublish": "tsc",
+		"prepare": "npm test && npm run perf",
 		"perf": "tsc && node test/perf",
 		"test": "tsc && node test/test"
 	},

readme.md

@@ -73,7 +73,12 @@ Running Linguist on this folder will return the following JSON:
 }
 ```
 
-Note that file paths in the output use only forward slashes as delimiters, even on Windows.
+### Notes
+
+- File paths in the output use only forward slashes as delimiters, even on Windows.
+- Do not rely on any language classification output from Linguist being immutable between runs.
+  Language data is fetched each run from the latest classifications of `github-linguist`.
+  This data is subject to change at any time and may change the results of a run even when using the same version of Linguist.
 
 ## API
 

src/schema.ts

@@ -3,18 +3,18 @@ import { Category, Language } from './types'
 export interface LanguagesScema {
 	[name: string]: {
 		language_id: number
-		fs_name?: string
+		fs_name?: Language
 		type: Category
 		group?: Language
 		color?: `#${string}`
 		aliases?: string[]
-		extensions?: string[]
+		extensions?: `.${string}`[]
 		filenames?: string[]
 		interpreters?: string[]
-		tm_scope?: string
+		tm_scope?: `${'source' | 'text'}.${string}`
 		ace_mode?: string
 		codemirror_mode?: string
-		codemirror_mime_type?: string
+		codemirror_mime_type?: `${string}/${string}`
 		wrap?: boolean
 	}
 }