WordNet Database Files for Node.js

Common errors

• Error: Cannot find module 'tar'

  cause An older version of `wordnet-db` was installed which had `tar` as a runtime dependency, and `tar` failed to install correctly.
  fix Upgrade to `wordnet-db@^3.1.13` to use the version where `tar` is no longer a dependency and dictionary files are directly bundled.

• WordNet data files appear corrupted or have incorrect line endings on Windows.

  cause When using `wordnet-db@3.0.0` or cloning the repository directly, Git's `core.autocrlf` setting on Windows converted line endings in the plain text data files, corrupting them.
  fix For version `3.0.0` specifically, ensure `git config core.autocrlf false` is set before cloning the repository. For later versions (3.1.x), this issue is largely mitigated by how files are packaged.

Warnings

• breaking The package name was changed from `WNdb` to `wordnet-db` to comply with npm naming rules. While old links might still resolve, all new installations and references should use `wordnet-db`.
  Fix: Update `package.json` dependencies and all `require()` statements from `WNdb` to `wordnet-db`.
• gotcha Older Node.js versions (specifically <0.6) are not supported due to the package's internal reliance on Node.js's built-in `zlib` module for handling compressed data.
  Fix: Ensure your Node.js environment is version 0.6.0 or higher. For modern applications, use the latest LTS Node.js release.
• breaking The method of database file distribution and installation changed significantly. In versions prior to `3.1.12`, a `tar` dependency was used. From `3.1.12` onwards, `tar` was removed, and from `3.1.13`, the `.tar.gz` archive was removed from the npm package, with dictionary files included directly. This affects installation logic and potential `tar` related issues.
  Fix: No direct fix needed for newer versions, as it simplifies installation. If you encounter `tar` related errors on older versions, upgrade to `wordnet-db@^3.1.13`.
• gotcha On Windows systems, if you are working with WordNet 3.0.0 directly from a git clone, automatic CRLF (Carriage Return Line Feed) conversion can corrupt the data files. This was relevant when text dict files were included uncompressed.
  Fix: Before cloning the repository on Windows for version 3.0.0, execute `git config core.autocrlf false` to prevent CRLF conversions that can damage data files.
• gotcha Installation issues were reported with `npm@5` due to postinstall script order. Version `3.1.6` introduced a fix by including `dict` files directly and disabling the postinstall script.
  Fix: If experiencing installation issues with `npm@5` on older versions, upgrade to `wordnet-db@^3.1.6` or later.

Install

• npm install wordnet-db npm
• yarn add wordnet-db yarn
• pnpm add wordnet-db pnpm

Imports

• wordnetDb
  wrong:

  import wordnetDb from 'wordnet-db';

  correct:

  const wordnetDb = require('wordnet-db');

  This package is CommonJS-only. ES modules import syntax will fail.
• dbPath
  wrong:

  import { path as dbPath } from 'wordnet-db';

  correct:

  const dbPath = require('wordnet-db').path;

  Properties like `path`, `files`, `version`, and `libVersion` are accessed directly from the default export object.
• dbVersion
  wrong:

  const { version: dbVersion } = require('wordnet-db');

  correct:

  const dbVersion = require('wordnet-db').version;

  While object destructuring works with `require`, direct property access is the idiomatic way shown in documentation for this package.

Quickstart

This script demonstrates how to import `wordnet-db`, access its properties (like path and versions), and verify the presence and content of a sample WordNet data file.

const wordnetDb = require('wordnet-db');
const fs = require('fs');
const path = require('path');

console.log('--- WordNet DB Information ---');
console.log(`Package version: ${wordnetDb.libVersion}`);
console.log(`WordNet data version: ${wordnetDb.version}`);
console.log(`Database files path: ${wordnetDb.path}`);
console.log(`Number of files: ${wordnetDb.files.length}`);

// Verify a common WordNet data file exists
const exampleFile = 'data.noun';
const fullPath = path.join(wordnetDb.path, exampleFile);

console.log(`\nChecking for existence of "${exampleFile}" at "${fullPath}"...`);

try {
  fs.accessSync(fullPath, fs.constants.F_OK);
  console.log(`SUCCESS: "${exampleFile}" found. WordNet database seems correctly installed.`);

  // Optionally, read a few lines to confirm content
  const content = fs.readFileSync(fullPath, 'utf8');
  console.log(`First 3 lines of ${exampleFile}:\n${content.split('\n').slice(0, 3).join('\n')}`);

} catch (err) {
  console.error(`ERROR: "${exampleFile}" not found or inaccessible. Installation may be incomplete or corrupted.`);
  console.error(err.message);
}