diff --git a/README.md b/README.md index f7c1109..9f250be 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,18 @@ Simply load this module after loading Highlight.js. You'll use the minified vers For more details of the usage see [Highlight.js main page](https://github.com/highlightjs/highlight.js#highlightjs). +### Usage with TypeScript import from npm package + +```typescript +import hljs from 'highlight.js'; +import tsql from 'highlight.js-tsql'; + +hljs.registerLanguage("tsql", tsql); + +// You can import the css here or into a bundler if you use one. +import 'highlight.js-tsql/dist/ssms.min.css'; +``` + ## Authors [David Simner](https://github.com/DavidSimner), [Greg Smulko](https://github.com/Greg-Smulko) diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..fdb5b1f --- /dev/null +++ b/package-lock.json @@ -0,0 +1,25 @@ +{ + "name": "highlight.js-tsql", + "version": "1.3.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "highlight.js-tsql", + "version": "1.3.0", + "license": "BSD-3-Clause", + "dependencies": { + "highlight.js": "^11.x" + } + }, + "node_modules/highlight.js": { + "version": "11.6.0", + "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-11.6.0.tgz", + "integrity": "sha512-ig1eqDzJaB0pqEvlPVIpSSyMaO92bH1N2rJpLMN/nX396wTpDA4Eq0uK+7I/2XG17pFaaKE0kjV/XPeGt7Evjw==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=12.0.0" + } + } + } +} diff --git a/package.json b/package.json index cd8e530..d5904eb 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,8 @@ { "name": "highlight.js-tsql", "description": "Syntax highlighting for T-SQL.", - "main": "dist/tsql.js", + "main": "src/languages/tsql.js", + "types": "types/index.d.ts", "keywords": [ "highlight", "syntax", @@ -9,7 +10,7 @@ "sql" ], "homepage": "https://github.com/highlightjs/highlightjs-tsql", - "version": "1.2.0", + "version": "1.3.0", "author": "Greg Smulko", "bugs": { "url": "https://github.com/highlightjs/highlightjs-tsql/issues" @@ -22,6 +23,11 @@ "files": [ "dist/tsql.min.js", "dist/tsql.es.min.js", - "dist/ssms.min.css" - ] + "dist/ssms.min.css", + "src/languages/tsql.js", + "types/index.d.ts" + ], + "dependencies": { + "highlight.js": "^11.x" + } } diff --git a/types/index.d.ts b/types/index.d.ts new file mode 100644 index 0000000..d5558f9 --- /dev/null +++ b/types/index.d.ts @@ -0,0 +1,6 @@ +import { LanguageFn } from "highlight.js"; + +declare module 'highlight.js-tsql' { + const tsql: LanguageFn; + export default tsql; +} \ No newline at end of file