nlcst-emoticon-modifier

Common errors

• Error [ERR_REQUIRE_ESM]: require() of ES Module /path/to/node_modules/nlcst-emoticon-modifier/index.js not supported.

  cause Attempting to use `require()` to import an ESM-only package.
  fix Refactor your code to use `import { emoticonModifier } from 'nlcst-emoticon-modifier'` within an ES module context. Ensure your `package.json` has `"type": "module"` or files end with `.mjs`.

• TypeError: emoticonModifier is not a function

  cause Incorrectly importing the `emoticonModifier` symbol, typically by trying to import a default export or using `require()` incorrectly.
  fix Use a named import: `import { emoticonModifier } from 'nlcst-emoticon-modifier'`. The package does not provide a default export.

• TS2307: Cannot find module 'nlcst-emoticon-modifier' or its corresponding type declarations.

  cause TypeScript compiler cannot locate the type definitions for the package, often related to `moduleResolution` settings or `skipLibCheck`.
  fix Ensure `npm install` has been run and `@types/nlcst` is installed if you're working with nlcst nodes directly. Check `tsconfig.json` for `moduleResolution` set to `node16` or `bundler` for modern ESM environments.

Warnings

• breaking Version 3.0.0 updated the minimum Node.js requirement to Node.js 16 and above.
  Fix: Ensure your Node.js environment is version 16 or newer. Update by using `nvm install 16` or similar version management tools.
• breaking Version 2.0.0 switched the package to be ESM-only. CommonJS `require()` statements are no longer supported.
  Fix: Migrate your project to use ES modules (`import`/`export` syntax). If you must use CommonJS, you will need to stick to `nlcst-emoticon-modifier@^1`.
• breaking Version 3.0.0 introduced the `exports` field in `package.json`, which affects how modules are resolved, especially for direct file imports (e.g., `require('pkg/file.js')`).
  Fix: Always use the main entry point `import { symbol } from 'nlcst-emoticon-modifier'`. Avoid direct deep imports into internal files unless explicitly documented, as these are no longer stable.
• breaking Version 3.0.0 removed the `complex-types.d.ts` file.
  Fix: Consumers should now rely on the main module's type declarations which provide the `Emoticon` type.
• gotcha To correctly register the `Emoticon` node type for TypeScript within the `nlcst` ecosystem (e.g., for `unist-util-visit`), you need to import the `nlcst-emoticon-modifier` package somewhere in your type declarations or application.
  Fix: Add `import type { Emoticon } from 'nlcst-emoticon-modifier';` or `/** @typedef {import('nlcst-emoticon-modifier')} */` to a relevant TypeScript file in your project.

Install

• npm install nlcst-emoticon-modifier npm
• yarn add nlcst-emoticon-modifier yarn
• pnpm add nlcst-emoticon-modifier pnpm

Imports

• emoticonModifier
  wrong:

  const emoticonModifier = require('nlcst-emoticon-modifier')

  correct:

  import { emoticonModifier } from 'nlcst-emoticon-modifier'

  This package is ESM-only since v2.0.0 and requires Node.js 16+ since v3.0.0. There is no default export.
• Emoticon
  wrong:

  import { Emoticon } from 'nlcst-emoticon-modifier'

  correct:

  import type { Emoticon } from 'nlcst-emoticon-modifier'

  Used for TypeScript type annotations. Importing the utility also registers the Emoticon node type with `@types/nlcst` globally.

Quickstart

Demonstrates how to integrate `emoticonModifier` into a `ParseEnglish` pipeline to transform ASCII emoticons into `EmoticonNode`s within an NLCST sentence, then inspects the resulting tree.

import { emoticonModifier } from 'nlcst-emoticon-modifier';
import { ParseEnglish } from 'parse-english';
import { inspect } from 'unist-util-inspect';

const parser = new ParseEnglish();
parser.tokenizeSentencePlugins.unshift(emoticonModifier);

const sentence = parser.parse('This makes me feel :).').children[0].children[0];

console.log(inspect(sentence));