
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
@scalar/build-tooling
Advanced tools
This package provides essential build and development tools for managing packages within the scalar/scalar repository. It includes:
These tools streamline the development process, ensure consistency across packages, and optimize the build output for different project types within the monorepo.
By default, all dependencies are externalized, and we don’t bundle anything for internal modules.
For deployed web applications, alternative build methods should be used to provide a complete client bundle. This ensures that all necessary dependencies are included for the end-user.
To use these build tools effectively, all package.json files should include the following scripts:
"scripts": {
"build": "scalar-build-rollup",
"types:check": "scalar-types-check",
"types:build": "scalar-types-build",
"format:check": "scalar-format-check",
"format": "scalar-format",
"lint:check": "scalar-lint-check",
"lint:fix": "scalar-lint-fix",
}
For Vite/Vue we need a different build command that uses Vite and vue-tsc
:
"scripts": {
"build": "scalar-build-vite",
"types:check": "scalar-types-check-vue",
"types:build": "scalar-types-build-vue",
"format:check": "scalar-format-check",
"format": "scalar-format",
"lint:check": "scalar-lint-check",
"lint:fix": "scalar-lint-fix",
}
For non-Vue projects, we use Rollup for builds due to its superior tree-shaking capabilities. This approach optimizes our bundle size.
Our Rollup configuration provides out-of-the-box support for importing JSON, YAML, and CSS files. Additionally, you can easily copy static files by specifying entries in the copy
parameter.
Here’s an example of a basic rollup.config.ts
file:
import type { RollupOptions } from 'rollup'
import { createRollupConfig } from './src/rollup-options'
const options: RollupOptions = {
// Specify the entry point(s) for your build
input: ['./src/index.ts'],
// Alternative: Use findEntryPoints for multiple entry points with TypeScript and CSS support
// input: await findEntryPoints({ allowCss: true }),
...createRollupConfig({
// Enable TypeScript support
typescript: true,
// Additional options can be added here to customize the build
}),
}
// Export the Rollup configuration
export default options
For Vue projects, we use Vite to build production code. Vite offers superior performance and a more streamlined development experience compared to traditional build tools.
While Vite uses Rollup under the hood for production builds, it provides additional optimizations and features specifically tailored for Vue projects. Most Rollup options can still be passed through, allowing for fine-grained control over the build process.
A basic Vite configuration for a Vue project might look like this:
import {
alias,
createViteBuildOptions,
findEntryPoints,
} from '@scalar/build-tooling'
import vue from '@vitejs/plugin-vue'
import { defineConfig } from 'vitest/config'
export default defineConfig({
plugins: [vue()],
resolve: {
// Provides @ -> './src' and @test -> './test' aliases
alias: alias(),
},
server: {
port: 5000,
},
build: createViteBuildOptions({
entry: await findEntryPoints({ allowCss: true }),
}),
})
FAQs
Build tooling and helpers
We found that @scalar/build-tooling demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.