1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-21 03:45:57 +01:00
mkdocs-material/tools/build/copy/index.ts

112 lines
3.4 KiB
TypeScript
Raw Normal View History

2021-02-20 18:03:53 +01:00
/*
* Copyright (c) 2016-2022 Martin Donath <martin.donath@squidfunk.com>
2021-02-20 18:03:53 +01:00
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
import * as fs from "fs/promises"
import * as path from "path"
2021-11-13 12:05:24 +01:00
import {
Observable,
from,
2022-04-02 18:36:59 +02:00
map,
2021-11-13 12:05:24 +01:00
mergeMap,
switchMap
} from "rxjs"
2021-02-20 18:03:53 +01:00
2021-02-26 16:14:18 +01:00
import { mkdir, read, resolve, write } from "../_"
2021-02-20 18:03:53 +01:00
/* ----------------------------------------------------------------------------
* Helper types
* ------------------------------------------------------------------------- */
/**
* Copy transform function
*
2021-02-21 14:34:17 +01:00
* @param data - File data
* @param name - File name
2021-02-20 18:03:53 +01:00
*
2021-02-21 14:34:17 +01:00
* @returns Transformed file data
2021-02-20 18:03:53 +01:00
*/
2021-02-21 14:34:17 +01:00
type CopyTransformFn = (data: string, name: string) => Promise<string>
2021-02-20 18:03:53 +01:00
/* ------------------------------------------------------------------------- */
/**
* Copy options
*/
interface CopyOptions {
2021-02-22 18:19:00 +01:00
from: string /* Source destination */
to: string /* Target destination */
2021-02-21 11:59:38 +01:00
transform?: CopyTransformFn /* Transform function */
2021-02-22 18:19:00 +01:00
watch?: boolean /* Watch mode */
2021-02-20 18:03:53 +01:00
}
/* ----------------------------------------------------------------------------
* Functions
* ------------------------------------------------------------------------- */
/**
* Copy a file
*
* @param options - Options
*
* @returns File observable
*/
export function copy(
2021-02-22 18:19:00 +01:00
{ transform, ...options }: CopyOptions
2021-02-20 18:03:53 +01:00
): Observable<string> {
2021-02-22 18:19:00 +01:00
return mkdir(path.dirname(options.to))
2021-02-20 18:03:53 +01:00
.pipe(
2021-02-21 11:59:38 +01:00
switchMap(() => typeof transform === "undefined"
2021-02-22 18:19:00 +01:00
? from(fs.copyFile(options.from, options.to))
2021-02-26 16:14:18 +01:00
: read(options.from)
2021-02-20 18:03:53 +01:00
.pipe(
2021-02-22 18:19:00 +01:00
switchMap(data => transform(data, options.from)),
2021-02-26 16:14:18 +01:00
switchMap(data => write(options.to, data))
2021-02-20 18:03:53 +01:00
)
),
2022-04-02 18:36:59 +02:00
map(() => options.to)
2021-02-20 18:03:53 +01:00
)
}
/**
* Copy all files matching the given pattern
*
* Note that this function rebases all files that match the pattern to the
2021-02-20 18:03:53 +01:00
* target folder, even if the pattern resolves to a parent folder.
*
* @param pattern - Pattern
* @param options - Options
*
* @returns File observable
*/
export function copyAll(
pattern: string, options: CopyOptions
): Observable<string> {
2021-02-22 18:19:00 +01:00
return resolve(pattern, { ...options, cwd: options.from })
2021-02-20 18:03:53 +01:00
.pipe(
mergeMap(file => copy({
...options,
2021-02-22 18:19:00 +01:00
from: `${options.from}/${file}`,
to: `${options.to}/${file.replace(/(\.{2}\/)+/, "")}`
2021-02-20 18:03:53 +01:00
}), 16)
)
}