Giter Club home page Giter Club logo

adapt-authoring-core's Issues

Mix of import and require and module.exports

Which version of node are you using? I can't get the import directives to work in node 8.11.1 without a transpiler.

Suggest using https://www.npmjs.com/package/esdoc-node to convert require + module.exports directives.

.esdoc.json includes don't work on windows cos the regexps are set with / but windows needs \\ to parse correctly.

probably need to switch to .esdoc.js and normalize the paths:

const os = require('os');
const norm = (rex)=>{
  switch (os.platform()) {
    case "win32":
      return rex.replace(/\//g, "\\\\");
  }
  return rex;
};

module.exports = {
  "source": "./",
  "destination": "./docs",
  "index": "./DOCS.md",
  "plugins": [
    {
     "name": "esdoc-standard-plugin",
      "option": {
        "brand": {
          "title": "Adapt authoring tool",
          "author": "Adapt",
          "site": "https://www.adaptlearning.org/",
          "image": "https://www.adaptlearning.org/wp-content/uploads/2015/11/home-hero-logo.png"
        }
      }
    },
    {
     "name": "esdoc-node"
    }
  ],
  "includes": [
    norm("node_modules/adapt-authoring-core/lib"),
    norm("node_modules/adapt-authoring-server/lib"),
    norm("node_modules/adapt-authoring-helloworld/lib"),
    norm("node_modules/adapt-authoring-logger/lib")
  ]
};

Would also give the option to automatically generate includes value from package jsons.

Make DependencyLoader agnostic with path delimiter

What happened?

DependencyLoader assumes forward slash is path delimiter

Expected behaviour

DependencyLoader should not assume forward slash is path delimiter

Steps to reproduce

Use Windows

Authoring tool version

Latest

Framework version

No response

What browsers are you seeing the problem on?

No response

Relevant log output

No response

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.