lassy-xpath

XPath parser and editor for searching LASSY XML files

https://github.com/centrefordigitalhumanities/lassy-xpath

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

XPath parser and editor for searching LASSY XML files

Basic Info
  • Host: GitHub
  • Owner: CentreForDigitalHumanities
  • License: bsd-3-clause
  • Language: TypeScript
  • Default Branch: develop
  • Size: 1.06 MB
Statistics
  • Stars: 0
  • Watchers: 3
  • Forks: 0
  • Open Issues: 12
  • Releases: 1
Created about 8 years ago · Last pushed 12 months ago
Metadata Files
Readme License Citation

README.md

DOI Build Status npm version

LASSY XPath

Module for working with XPath queries on LASSY XML files. It includes a graphical editor including auto completion, macros and validation based on Ace, a parser and validator based on ts-xpath and an "extractinator" for determining XPaths to get each node from the returned tree separately. It also has a "reconstructor" to create an XML structure representing the query tree. The functionality can be used as an Angular module.

It is developed for and used by the GrETEL search tool.

Compatibility

  • v0.15.x is for Angular 15
  • v0.12.x is for Angular 12
  • v0.4.3 and down should work with Angular 6 and JQuery

Angular

bash npm install lassy-xpath

Import the module:

```typescript import { LassyXPathModule } from 'lassy-xpath';

@NgModule({ imports: [LassyXPathModule] }) export class AppModule {} ```

Includes the services:

```typescript import { MacroService, ExtractinatorService, ValueEvent } from 'lassy-xpath';

@Component() export class ExampleComponent { constructor( macroService: MacroService, private extractinatorService: ExtractinatorService) { // set the macros to use in the editor macroService.loadDefault(); }

inputChanged(event: ValueEvent) {
    this.valid = !event.error;
    this.value = event.xpath;
    console.log(this.extractinatorService.extract(event.xpath));
}

} ```

Embeds an editor:

html <lx-editor [value]="value" (onChange)="inputChanged($event)" autofocus="true"></lx-editor>

Use the ParserService for parsing/validating a LASSY XML XPath.

Publishing a new version

Run npm run publish from root or follow these steps:

  1. Compile using npm run build
  2. cd dist/lassy-xpath
  3. Optionally run npm pack to test the package locally
  4. Remove the lassy-xpath-x.xx.x.tgz file (if generated in 3)
  5. Run npm publish

Owner

  • Name: Centre for Digital Humanities
  • Login: CentreForDigitalHumanities
  • Kind: organization
  • Email: cdh@uu.nl
  • Location: Netherlands

Interdisciplinary centre for research and education in computational and data-driven methods in the humanities.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: lassy-xpath
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - name: >-
      Research Software Lab, Centre for Digital Humanities,
      Utrecht University
    website: >-
      https://cdh.uu.nl/centre-for-digital-humanities/research-software-lab/
    city: Utrecht
    country: NL
  - given-names: Sheean
    family-names: Spoel
    email: s.j.j.spoel@uu.nl
    affiliation: >-
      Research Software Lab, Centre for Digital Humanities,
      Utrecht University
    orcid: 'https://orcid.org/0000-0002-6802-4135'
identifiers:
  - type: doi
    value: 10.5281/zenodo.10426257
repository-code: 'https://github.com/CentreForDigitalHumanities/lassy-xpath'
url: 'https://npmjs.com/lassy-xpath'
abstract: >-
  NPM module for working with XPath queries on LASSY XML
  files. It includes a graphical editor including auto
  completion, macros and validation based on Ace, a parser
  and validator based on ts-xpath and an "extractinator" for
  determining XPaths to get each node from the returned tree
  separately. It also has a "reconstructor" to create an XML
  structure representing the query tree. The functionality
  can be used as an Angular module.
keywords:
  - gretel
  - corpus research
  - syntax
  - xpath
license: MIT
commit: 8f69c58
version: 0.15.1
date-released: '2023-02-21'

GitHub Events

Total
  • Push event: 1
Last Year
  • Push event: 1

Dependencies

package-lock.json npm
  • 1105 dependencies
package.json npm
  • @angular-devkit/build-angular ^12.1.0 development
  • @angular/cli ^12.1.0 development
  • @angular/common ^12.1.0 development
  • @angular/compiler ^12.1.0 development
  • @angular/compiler-cli ^12.1.0 development
  • @angular/core ^12.1.0 development
  • @angular/platform-browser ^12.1.0 development
  • @angular/platform-browser-dynamic ^12.1.0 development
  • @types/jasmine ^3.7.7 development
  • @types/node ^15.12.4 development
  • ajv ^6.5.3 development
  • copyfiles ^2.4.1 development
  • core-js ^2.5.7 development
  • jasmine ^3.7.0 development
  • jasmine-core ^3.1.0 development
  • jasmine-ts ^0.4.0 development
  • karma ^6.3.4 development
  • karma-chrome-launcher ^3.1.0 development
  • karma-jasmine ^4.0.1 development
  • karma-jasmine-html-reporter ^1.6.0 development
  • ng-packagr ^12.1.0 development
  • rxjs ^6.6.7 development
  • ts-loader ^4.1.0 development
  • tslint ^6.1.3 development
  • typescript ~4.2.4 development
  • webpack ^5.40.0 development
  • zone.js ^0.11.4 development
  • brace ^0.11.1
  • karma-coverage ^2.0.3
  • ts-xpath ^0.3.1
  • tslib ^2.3.0
projects/lassy-xpath/package.json npm
  • tslib ^2.1.0
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v2 composite
  • github/codeql-action/analyze v1 composite
  • github/codeql-action/autobuild v1 composite
  • github/codeql-action/init v1 composite
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite