Add usage example in docs

[calculuschild]

I'm failing to get this to run in my project. Jest seems to be struggling to import this package and it's not obvious what the usage is for any of the given parameters in runAllMarkedSpecTests. Can we get a usage example added to the docs? And do we need to use Babel to transpile this or something?

I am attempting this:

import { runAllMarkedSpecTests } from '@markedjs/testutils';

import extendedTable from '../src/index.js';


describe('Core Marked Tests', () => {
  it('should pass all marked tests', () => {
    runAllMarkedSpecTests({ addExtension: extendedTable, outputCompletionTables :true });
  });
});

But can't even get past the import step:

 Test suite failed to run

    Jest encountered an unexpected token

    Jest failed to parse a file. This happens e.g. when your code or its dependencies use non-standard JavaScript syntax, or when Jest is not configured to support such syntax.

    Out of the box Jest supports Babel, which will be used to transform your files into valid JS based on your Babel configuration.

    By default "node_modules" folder is ignored by transformers.

    Here's what you can do:
     • If you are trying to use ECMAScript Modules, see https://jestjs.io/docs/ecmascript-modules for how to enable it.
     • If you are trying to use TypeScript, see https://jestjs.io/docs/getting-started#using-typescript
     • To have some of your "node_modules" files transformed, you can specify a custom "transformIgnorePatterns" in your config.
     • If you need a custom transformation specify a "transform" option in your config.
     • If you simply want to mock your non-JS modules (e.g. binary assets) you can stub them out with the "moduleNameMapper" config option.

    You'll find more details and examples of these config options in the docs:
    https://jestjs.io/docs/configuration
    For information about custom transformations, see:
    https://jestjs.io/docs/code-transformation

    Details:

    C:\Users\Trevor\Documents\GitHub\marked-extended-tables\node_modules\@markedjs\testutils\src\index.js:1
    ({"Object.<anonymous>":function(module,exports,require,__dirname,__filename,jest){export * from "./get-tests.js";
                                                                                      ^^^^^^

    SyntaxError: Unexpected token 'export'

      1 | import { marked } from 'marked';
    > 2 | import { runAllMarkedSpecTests } from '@markedjs/testutils'
        | ^
      3 |
      4 | import extendedTable from '../src/index.js';
      5 |

      at Runtime.createScriptFromCode (node_modules/jest-runtime/build/index.js:1505:14)
      at Object.require (spec/marked.test.js:2:1)
      ```

[calculuschild]

Ah, I see in Marked this is used with the node tester, not Jest, so that gets around the importing issue.

But I'm still not clear how addExtension is meant to be used. Is this correct?

import { runAllMarkedSpecTests } from '@markedjs/testutils';
import extendedTable from '../src/index.js';

runAllMarkedSpecTests({ addExtension: extendedTable, outputCompletionTables: true });

[UziTech]

addExtension is a function that sends the marked instance as an argument so you can add the extension using marked.use

You can see how this is used in marked-katex-extension