Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert source components to use TypeScript #209

Merged
merged 4 commits into from
Jun 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,10 @@
"svelte": "^3.48.0",
"svelte-check": "^2.7.1",
"svelte-focus-key": "^0.3.2",
"svelte-preprocess": "^4.10.7",
"svelte2tsx": "^0.5.10",
"totalist": "^3.0.0",
"typescript": "^4.7.2",
"typescript": "^4.7.3",
"vitest": "^0.13.1"
},
"repository": {
Expand Down
65 changes: 50 additions & 15 deletions src/Highlight.svelte
Original file line number Diff line number Diff line change
@@ -1,26 +1,61 @@
<script>
/** @type {{ name?: string; register: (hljs: any) => Record<string, any>; }} */
export let language = { name: undefined, register: undefined };

/**
* Source code to highlight
* @type {string}
*/
<script context="module" lang="ts">
import type { LanguageFn } from "highlight.js";

export type HighlightedCode = undefined | string;

export interface Language {
name?: string;
register: LanguageFn;
}

export interface Events {
highlight: {
highlighted?: HighlightedCode;
};
}
</script>

<script lang="ts">
interface $$Props extends Partial<HTMLPreElement> {
/**
* Specify the source code to highlight.
*/
code?: any;

/**
* Provide the language to highlight the code.
* Import languages from `svelte-highlight/languages/*`.
*/
language?: Language;

/**
* Set to `true` for the language name to be
* displayed at the top right of the code block.
*/
langtag?: boolean;
}

interface $$Slots {
default: {
highlighted: HighlightedCode;
};
}

export let language: Language = {
name: undefined,
register: undefined,
};

export let code = undefined;

/**
* Add a language tag to the top-right
* of the code block
* @type {boolean}
*/
export let langtag = false;

import hljs from "highlight.js/lib/core";
import { createEventDispatcher, afterUpdate } from "svelte";

const dispatch = createEventDispatcher();
const dispatch = createEventDispatcher<Events>();

let highlighted = undefined;
let highlighted: HighlightedCode = undefined;

afterUpdate(() => {
if (highlighted) dispatch("highlight", { highlighted });
Expand Down
44 changes: 32 additions & 12 deletions src/HighlightAuto.svelte
Original file line number Diff line number Diff line change
@@ -1,23 +1,43 @@
<script>
/**
* Source code to highlight
* @type {string}
*/
<script context="module" lang="ts">
import type { HighlightedCode, Language, Events } from "./Highlight.svelte";
</script>

<script lang="ts">
interface $$Props extends Partial<HTMLPreElement> {
/**
* Specify the source code to highlight.
*/
code?: any;

/**
* Provide the language to highlight the code.
* Import languages from `svelte-highlight/languages/*`.
*/
language?: Language;

/**
* Set to `true` for the language name to be
* displayed at the top right of the code block.
*/
langtag?: boolean;
}

interface $$Slots {
default: {
highlighted: HighlightedCode;
};
}

export let code = undefined;

/**
* Add a language tag to the top-right
* of the code block
* @type {boolean}
*/
export let langtag = false;

import hljs from "highlight.js";
import { createEventDispatcher, afterUpdate } from "svelte";

const dispatch = createEventDispatcher();
const dispatch = createEventDispatcher<Events>();

let highlighted = undefined;
let highlighted: HighlightedCode = undefined;
let language = undefined;

afterUpdate(() => {
Expand Down
36 changes: 25 additions & 11 deletions src/HighlightSvelte.svelte
Original file line number Diff line number Diff line change
@@ -1,15 +1,29 @@
<script>
/**
* Source code to highlight
* @type {string}
*/
<script context="module" lang="ts">
import type { HighlightedCode, Language, Events } from "./Highlight.svelte";
</script>

<script lang="ts">
interface $$Props extends Partial<HTMLPreElement> {
/**
* Specify the source code to highlight.
*/
code?: any;

/**
* Set to `true` for the language name to be
* displayed at the top right of the code block.
*/
langtag?: boolean;
}

interface $$Slots {
default: {
highlighted: HighlightedCode;
};
}

export let code = undefined;

/**
* Add a language tag to the top-right
* of the code block
* @type {boolean}
*/
export let langtag = false;

import hljs from "highlight.js/lib/core";
Expand All @@ -18,7 +32,7 @@
import css from "highlight.js/lib/languages/css";
import { createEventDispatcher, afterUpdate } from "svelte";

const dispatch = createEventDispatcher();
const dispatch = createEventDispatcher<Events>();

hljs.registerLanguage("xml", xml);
hljs.registerLanguage("javascript", javascript);
Expand Down
File renamed without changes.
2 changes: 2 additions & 0 deletions svelte.config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import adapter from "@sveltejs/adapter-static";
import fs from "fs";
import preprocess from "svelte-preprocess"
import { optimizeImports } from "carbon-preprocess-svelte";

const pkg = JSON.parse(
Expand All @@ -16,6 +17,7 @@ const CONTENT = {
/** @type {import('@sveltejs/kit').Config} */
const config = {
preprocess: [
preprocess(),
optimizeImports(),
{
script: ({ content }) => {
Expand Down
8 changes: 7 additions & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"extends": "./.svelte-kit/tsconfig.json",
"include": ["demo/**/*.js", "demo/**/*.svelte", "tests/*.svelte"]
"include": [
"src/**/*.svelte",
"src/**/*.ts",
"demo/**/*.js",
"demo/**/*.svelte",
"tests/*.svelte"
]
}
20 changes: 16 additions & 4 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -1378,6 +1378,18 @@ svelte-preprocess@^4.10.5:
sorcery "^0.10.0"
strip-indent "^3.0.0"

svelte-preprocess@^4.10.7:
version "4.10.7"
resolved "https://registry.yarnpkg.com/svelte-preprocess/-/svelte-preprocess-4.10.7.tgz#3626de472f51ffe20c9bc71eff5a3da66797c362"
integrity sha512-sNPBnqYD6FnmdBrUmBCaqS00RyCsCpj2BG58A1JBswNF7b0OKviwxqVrOL/CKyJrLSClrSeqQv5BXNg2RUbPOw==
dependencies:
"@types/pug" "^2.0.4"
"@types/sass" "^1.16.0"
detect-indent "^6.0.0"
magic-string "^0.25.7"
sorcery "^0.10.0"
strip-indent "^3.0.0"

svelte2tsx@^0.5.10:
version "0.5.10"
resolved "https://registry.yarnpkg.com/svelte2tsx/-/svelte2tsx-0.5.10.tgz#32f244534361325e40f8976173ce2569c7e71fdb"
Expand Down Expand Up @@ -1464,10 +1476,10 @@ typescript@*, typescript@^4.6.3:
resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.6.3.tgz#eefeafa6afdd31d725584c67a0eaba80f6fc6c6c"
integrity sha512-yNIatDa5iaofVozS/uQJEl3JRWLKKGJKh6Yaiv0GLGSuhpFJe7P3SbHZ8/yjAHRQwKRoA6YZqlfjXWmVzoVSMw==

typescript@^4.7.2:
version "4.7.2"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.7.2.tgz#1f9aa2ceb9af87cca227813b4310fff0b51593c4"
integrity sha512-Mamb1iX2FDUpcTRzltPxgWMKy3fhg0TN378ylbktPGPK/99KbDtMQ4W1hwgsbPAsG3a0xKa1vmw4VKZQbkvz5A==
typescript@^4.7.3:
version "4.7.3"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.7.3.tgz#8364b502d5257b540f9de4c40be84c98e23a129d"
integrity sha512-WOkT3XYvrpXx4vMMqlD+8R8R37fZkjyLGlxavMc4iB8lrl8L0DeTcHbYgw/v0N/z9wAFsgBhcsF0ruoySS22mA==

universalify@^0.1.2:
version "0.1.2"
Expand Down