@gobstones/gobstones-scripts/project-types/CLILibrary/package-scripts.js

Scripts to abstract away build configuration of Gobstones Project's libraries and modules.

const { tasks } = require('@gobstones/gobstones-scripts');

const defaultConfiguration = {
    options: {
        scripts: false,
        logLevel: 'warn',
        'help-style': 'basic'
    },

    scripts: {
        default: {
            script: tasks.nps('help'),
            hiddenFromHelp: true
        },

        dev: {
            script: tasks.serially(tasks.tsc({ emit: false }), tasks.tsx({ file: './src/index.ts' })),
            description: 'Run "index.ts" in development mode',
            watch: {
                script: tasks.tsx({ file: './src/index.ts', watch: './src/**/*.ts' }),
                description: 'Run "index.ts" in development mode and watch for changes'
            }
        },

        build: {
            script: tasks.serially(tasks.nps('clean.dist'), tasks.rollup()),
            description: 'Build the application into "dist" folder'
        },

        test: {
            script: tasks.serially(tasks.nps('clean.coverage'), tasks.nps('lint'), tasks.jest({ coverage: true })),
            description: 'Run the tests, including linting',
            watch: {
                script: tasks.serially(tasks.jest({ coverage: true, watch: true })),
                description: 'Run the tests with no linting, and wait for changes'
            },
            serve: {
                script: tasks.serially(
                    tasks.nps('clean.coverage'),
                    tasks.jest({ coverage: true, noThreshold: true }),
                    tasks.nps('test.coveragefix'),
                    tasks.serve({ dir: './coverage' })
                ),
                description: 'Run the tests, including linting, and serve the coverage reports in HTML'
            },
            coveragefix: {
                script: tasks.replace({
                    file: './coverage',
                    match: 'prettyPrint\\(\\)',
                    replace:
                        'prettyPrint();var elems = document.querySelectorAll' +
                        '("td.file a");for (var i=0; i< elems.length; i++) ' +
                        '{if (document.location.pathname && !document.location.' +
                        'pathname.endsWith("html")) {var pathParts = document.' +
                        'location.pathname.split("/");var lastFolder = ' +
                        'pathParts[pathParts.length-1];elems[i].setAttribute("' +
                        'href", "./" + lastFolder + "/" + elems[i].getAttribute("href"));}}'
                }),
                description: 'Fix coverage generated reports in HTML that are outputed with broken links',
                hiddenFromHelp: true
            }
        },

        doc: {
            script: tasks.serially(
                tasks.nps('clean.docs'),
                tasks.typedoc(),
                tasks.copy({ src: './docs/index.html', dest: './docs/globals.html' })
            ),
            description: 'Run Typedoc and generate docs',
            watch: {
                script: tasks.serially(tasks.nps('doc'), tasks.typedoc({ watch: true })),
                description: 'Run Typedoc and generate docs and watch for changes.'
            },
            serve: {
                script: tasks.serially(tasks.nps('doc'), tasks.serve({ dir: './docs' })),
                description: 'Run Typedoc and generate docs, then serve the docs as HTML',
                watch: {
                    script: tasks.serially(
                        tasks.nps('doc'),
                        tasks.concurrently({
                            typedoc: tasks.typedoc({ watch: true }),
                            serve: tasks.serve({ dir: './docs' })
                        })
                    ),
                    description: 'Run Typedoc and generate docs and watch for changes while serving the docs as HTML'
                }
            }
        },

        clean: {
            script: tasks.serially(tasks.nps('clean.dist'), tasks.nps('clean.docs'), tasks.nps('clean.coverage')),
            description: 'Remove all automatically generated files and folders',
            hiddenFromHelp: true,
            dist: {
                script: tasks.remove({ files: './dist' }),
                description: 'Delete the dist folder',
                hiddenFromHelp: true
            },
            docs: {
                script: tasks.remove({ files: './docs' }),
                description: 'Delete the docs folder',
                hiddenFromHelp: true
            },
            coverage: {
                script: tasks.remove({ files: './coverage' }),
                description: 'Delete the coverage folder',
                hiddenFromHelp: true
            }
        },

        lint: {
            script: tasks.serially(tasks.eslint()),
            description: 'Run ESLint on all the files (src and tests)',
            fix: {
                script: tasks.serially(tasks.eslint({ fix: true })),
                description: 'Run ESLint on all the files (src and tests) with --fix option'
            }
        },

        prettify: {
            script: tasks.serially(
                tasks.prettify({
                    files: './.husky/*[^_]'
                }),
                tasks.prettify({
                    files: './{.github,.vscode,project-types,src,test}/{**,.}/*.{js,jsx,cjs,mjs,ts,tsx,mts,cts,yml,md,json,js}'
                }),
                tasks.prettify({
                    files: '{.czrc,.editorconfig,.gitignore,.npmignore,.npmrc,.prettierrc}'
                }),
                tasks.prettify({
                    files: './*.{js,jsx,cjs,mjs,ts,tsx,mts,cts,yml,md,json,js}'
                })
            ),
            description: 'Run Prettier on all the files, writing the results'
        },

        changelog: {
            script: tasks.changelog(),
            description: 'Generate changelog based on commits',
            scratch: {
                script: tasks.changelog({ scratch: true }),
                description: 'Generate changelog based on tags, starting from scratch',
                hiddenFromHelp: true
            },
            hiddenFromHelp: true
        },

        license: {
            script: tasks.license(),
            hiddenFromHelp: true,
            description: 'Add license information to all code files in the project',
            remove: {
                script: tasks.license('remove'),
                hiddenFromHelp: true,
                description: 'Add license information to all code files in the project'
            }
        }
    }
};

module.exports = defaultConfiguration;