Expose report-related APIs in another package about eslint-plugin-prettier HOT 5 CLOSED

I wouldn't mind doing this in theory, but it feels like the helper functions are sufficiently small and eslint-specific that it wouldn't be worthwhile. For example, all of the helpers use getLocFromIndex, context, and fixer, which are ESLint APIs and (as far as I know) have no direct equivalent in tslint.

I don't think your proposed interface would work, because something like reportInsert would need to have some way of actually reporting an error, and that can't happen unless they either return a value or accept a report function.

from eslint-plugin-prettier.

The context is not a necessary argument for reporters, for example if there is the suggested API:

return {
  Program() {
    if (!prettier) {
      // Prettier is expensive to load, so only load it if needed.
      prettier = require('prettier');
    }
    const prettierSource = prettier.format(source, prettierOptions);
    if (source !== prettierSource) {
      suggestedAPI.reportDifferences(source, prettierSource, {
        reportInsert: (...args) => reportInsert(context, ...args),
        reportDelete: (...args) => reportDelete(context, ...args),
        reportReplace: (...args) => reportReplace(context, ...args),
      });
    }
  }
};

We can call context as a contextual value so that it wouldn't have to pass in reporters directly.

For TSLint vs ESLint API, see this.

If you still think my proposed interface wouldn't work, I can send a PR here to show what it'd be in my proposal.

from eslint-plugin-prettier.

See #40 for my proposal

from eslint-plugin-prettier.

cc @zertosh, any thoughts on this?

from eslint-plugin-prettier.

Sounds good to me!

from eslint-plugin-prettier.