Skip to content

Instantly share code, notes, and snippets.

@Xananax
Created September 1, 2021 17:31
Show Gist options
  • Save Xananax/5dca3a1dd7070e4fdebe2927e4aeb55b to your computer and use it in GitHub Desktop.
Save Xananax/5dca3a1dd7070e4fdebe2927e4aeb55b to your computer and use it in GitHub Desktop.
MDSvex Global Components
import remarkAbbr from 'remark-abbr'
import rehypeSlug from 'rehype-slug'
import rehypeAutolinkHeadings from 'rehype-autolink-headings'
import md from 'mdsvex'
export const extensions = ['.svelte.md', '.md', '.svx']
export const mdsvex = md.mdsvex({
extensions,
smartypants: {
dashes: 'oldschool'
},
remarkPlugins: [remarkAbbr],
rehypePlugins: [
rehypeSlug,
[
rehypeAutolinkHeadings,
{
behavior: 'wrap'
}
]
]
})
import { join, basename, extname } from 'path'
export const defaults = {
extensions: ['.svelte.md', '.md', '.svx'],
dir: `$lib`,
list: []
}
/**
* Injects global imports in all your mdsvex files
* Specify:
* - the root dir (defaults to `src/lib`)
* - the array list of components (with extension), like `['Component.svelte']`
* - the valid extensions list as an array (defaults to `['.svelte.md', '.md', '.svx']`)
*
* If you want the component name to be different from the file name, you can specify an array
* of arrays: `['Component.svelte', ['Another', 'AnotherComp.svelte'], 'ThirdComp.svelte']`
*
* @param {Object} options options described above
* @returns a preprocessor suitable to plug into the `preprocess` key of the svelte config
*/
export const mdsvexGlobalComponents = (options = {}) => {
const { extensions, dir, list } = { ...defaults, ...options }
const extensionsRegex = new RegExp('(' + extensions.join('|').replace(/\./g, '\\.') + ')$', 'i')
if (!list || !list.length || !Array.isArray(list)) {
throw new Error(`"list" option must be an array and contain at least one element`)
}
const imports = list
.map((entry) => {
let name = ''
if (Array.isArray(entry)) {
name = entry[0]
entry = entry[1]
}
const ext = extname(entry)
const path = join(dir, entry)
name = name || basename(entry, ext)
return `\nimport ${name} from "${path}"`
})
.join('\n')
const preprocessor = {
script(thing) {
const { content, filename, attributes, markup } = thing
if (!filename.match(extensionsRegex)) {
return { code: content }
}
const hasModuleContext = /^<script context="module">/.test(markup)
const isModulePass = attributes?.context === 'module'
const isValidPass = (hasModuleContext && isModulePass) || !hasModuleContext
if (!isValidPass) {
return { code: content }
}
return { code: `${imports}\n${content}` }
}
}
return preprocessor
}
import preprocess from 'svelte-preprocess'
import { mdsvex, extensions } from './svelte-kit/mdsvex.config.js'
import { mdsvexGlobalComponents } from './svelte-kit/mdsvexGlobalComponents.js'
const globalComponents = mdsvexGlobalComponents({
dir: `$lib/components`,
list: ['Note.svelte', 'Youtube.svelte', ['Ref', 'RefLink.svelte']],
extensions
})
/** @type {import('@sveltejs/kit').Config} */
const config = {
extensions: ['.svelte', ...extensions],
preprocess: [preprocess(), globalComponents, mdsvex],
kit: {
target: '#svelte',
}
}
export default config
@Xananax
Copy link
Author

Xananax commented May 2, 2023

Oh sorry, I was not very focused 😅

In retrospect your question was evident. To answer it: no, I don't know of anything better, but this should work. If it doesn't, share your repo and I'll probably be able to help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment