Giter Club home page Giter Club logo

wordnet-db's Introduction

wordnet-db

NPM version Build Status

A package to install WordNet database files for Node.js modules. Used by wordpos project which is based on natural WordNet module.

Note: This repository was previously name WNdb. Its new name complies with npm naming rules. Although old links will still work, it is recommended to change references to the new name.

Description

This package contains the core DB files of WordNet 3.1 downloaded from WordNet files.

Other "standoff" files may be added in the future.

The purpose of this package is to allow a convenient way to download WordNet files off-line rather than on-demand for node modules that require it.

Installation

  npm install wordnet-db

Package is about 10 MB in size and uncompresses to about 34 MB. The DB file wordnet-db-3.1.tar.gz is unpacked at install time.

Usage

var wndb = require('wordnet-db');
console.log(wndb);
// output:
{ libVersion: '3.1.13',
  version: '3.1',
  path: 'D:\\dev\\wordnet-db\\dict',
  files:
   [ 'data.adj',
     'data.adv',
     'data.noun',
     'data.verb',
     'index.adj',
     'index.adv',
     'index.noun',
     'index.sense',
     'index.verb' ]
}

Properties

wndb.path (string) -- the path to the installed WordNet DB files

wndb.files (array<string>) -- list of file names under the path

wndb.version (string) -- version string of WordNet database file

wndb.libVersion (string) -- version of wordnet-db package

Change log

  • 3.1.14 -- Added libVersion.
  • 3.1.13 -- Remove WN tar.gz from npm package.
  • 3.1.12 -- remove tar dependency.
  • 3.1.11 -- move tar to devDependencies - fix crlf issue. Add pre-publish test for crlf.
  • 3.1.7/8/9/10 -- move tar to devDependencies
  • 3.1.6 -- fix for npm@5 postinstall order issue. Include /dict files and disable postinstall script.
  • 3.1.4 -- Updated with PR #12. Fix npm package.
  • 3.1.2 -- repository renamed to wordnet-db.
  • 3.1.1 -- fixed WNdb tar folder structure.
  • 3.1.0 -- updated to WordNet 3.1 DB.
  • 3.0.1 -- this includes the actual WordNet tar file, which is unpacked at install time. There should be no CRLF issues. Uses build-in 'zlib' package, therefore requires node >= 0.6.
  • 3.0.0 -- includes the uncompressed (text) dict files. On Windows systems, do a git config core.autocrlf false before cloning so that CRLF isn't applied to data files.
  • 3.0.x are pegged to WordNet 3.0 DB.

License

wordnet-db package: Copyright (c) 2012-2020, [email protected] (The MIT License)

See LICENSE file for complete Princeton University WordNet(r) License.

wordnet-db's People

Contributors

moos avatar tsenmu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

wordnet-db's Issues

Build to single file

Have a project that has added this as a dependency. This project uses webpack to resolve all dependencies into a single build file. Current understanding is because this project is not built into a single file, it tries to resolve it within my project. The /dict directory path cannot resolve. Have to go into node_modules and copy dict to my root directory for it to resolve.

Would you be open to adding webpack and building this project to a single file? Happy to do the leg work for you and make a pull request. Thanks for this!

Package [email protected] (latest) broke unpack.js

node_modules\wndb-with-exceptions\unpack.js:52
    .pipe(tar.Extract({ path: __dirname }))
              ^

TypeError: tar.Extract is not a function
    at extractTarball (F:\Repositories\iris-bot-engine.git\node_modules\wndb-with-exceptions\unpack.js:52:15)
    at Object.<anonymous> (F:\Repositories\iris-bot-engine.git\node_modules\wndb-with-exceptions\unpack.js:58:1)
    at Module._compile (module.js:571:32)
    at Object.Module._extensions..js (module.js:580:10)
    at Module.load (module.js:488:32)
    at tryModuleLoad (module.js:447:12)
    at Function.Module._load (module.js:439:3)
    at Module.runMain (module.js:605:10)
    at run (bootstrap_node.js:420:7)
    at startup (bootstrap_node.js:139:9)

[email protected] was the last version compatible with unpack.js

In [email protected] method tar.Extract was renamed tar.x see:
[email protected] => tar.js vs [email protected] => tar.js

You are using tar@latest in package.json it should be [email protected]

Just a tiny bit of documentation?

It's not immediately clear to me how to begin to use this module. I have it installed with natural, and I see a couple examples in the natural documentation. But the properties available to a new natural.WordNet() object don't seem obviously related to documentation I see at the WordNet site itself. I'm probably missing something simple, but would appreciate being pointed in the right direction. Thanks.

Difference between 3.0 and 3.1

Are there any differences between 3.0 and 3.1? Or rather, are there any incompatibilities between the two versions?

I am asking this because the archive in this repository and the latest tarball do not contain the same amount of files at all!

I am also asking this because I will propose a PR that will install the dictionaries directly from princeton.edu instead of keeping a 10Mb file in this repository.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.