xc-core-ts

0.1.0 verified Sat Apr 25 auth: no javascript

A TypeScript library starter project by Alex Jover Morales, version 0.1.0. It provides a zero-setup environment with RollupJS for optimized bundles, Jest for testing, Prettier and TSLint for code quality, TypeDoc for documentation, and automatic type generation. Supports tree-shaking and multi-platform bundles. Note: this is a starter template, not a library, but published as an npm package. Release cadence is unknown.

Common errors

error Cannot find module 'xc-core-ts' ↓

cause Package is not a library; it's a starter template with no main entry point exporting useful code.

fix

Do not npm install xc-core-ts as a dependency. Clone the repo and build your own library.

error TSLint is deprecated. ↓

cause TSLint has been deprecated in favor of ESLint with TypeScript support.

fix

Replace TSLint with ESLint and @typescript-eslint/parser and plugin.

error Error: Node version >=6.0.0 required. ↓

cause Package.json engines field specifies outdated Node version.

fix

Update your Node.js version or modify the engines field to match your environment.

Warnings

gotcha This package is a template, not a functional library. Installing it as a dependency will provide no runtime API. ↓

fix Clone the repository and build your own library; do not npm install xc-core-ts for use as a dependency.

deprecated TSLint is used instead of ESLint; TSLint is deprecated in favor of ESLint with TypeScript support. ↓

fix Migrate to ESLint using packages like @typescript-eslint/eslint-plugin.

gotcha Greenkeeper badge is present but Greenkeeper is deprecated; use Renovate or Dependabot instead. ↓

fix Remove Greenkeeper and set up Dependabot or Renovate for dependency updates.

gotcha Node engine requirement is >=6.0.0, which is outdated. Modern TypeScript may not run on such old Node versions. ↓

fix Update engines field in package.json to >=10.0.0 or later.

gotcha The package uses RollupJS for bundling, but configuration may need adjustment for modern ESM and CJS outputs. ↓

fix Review rollup.config.js and update to latest Rollup plugin versions.

Install

npm install xc-core-ts

yarn add xc-core-ts

pnpm add xc-core-ts

Imports

myLib
wrong
```
const myLib = require('xc-core-ts')
```
correct
```
import myLib from 'xc-core-ts'
```
ESM default export; CommonJS require might not work due to ESM-first setup.

something

wrong

import something from 'xc-core-ts/dist/lib/something'

correct

import { something } from 'xc-core-ts/dist/lib/something'

Use named import for internal modules; default import may not be available.

Type definitions
wrong
```
import { MyType } from 'xc-core-ts' (if only used as type)
```
correct
```
import type { MyType } from 'xc-core-ts'
```
TypeScript types are exported; use import type for type-only imports to avoid bundling.

Quickstart

Shows how to clone and use the starter template, then import the generated library.

// This is a starter template, not a library. To use it:
// git clone https://github.com/alexjoverm/typescript-library-starter.git YOURFOLDERNAME
// cd YOURFOLDERNAME
// npm install
// Then edit src/ to build your library.
// To import the built library in another project:
import myLib from 'xc-core-ts';
console.log(myLib);