Absolute filePaths used in output

[kimburgess]

What version of textlint are you using?
11.9.1

When running textlint, outputted results list absolute paths. Potential cause:

textlint/packages/textlint/src/util/find-util.ts

Lines 78 to 87 in 538b64e

	glob.sync(pattern, {
	cwd,
	absolute: true,
	nodir: true,
	ignore: ignoredPatterns
	}).forEach((filePath: string) => {
	// workaround for windows
	// https://github.com/isaacs/node-glob/issues/74#issuecomment-31548810
	addFile(path.resolve(filePath));
	});

This behaviour deviates from the common linting tools and breaks compatibility with some commonly useful tooling, such as default configurations for GitHub problem matchers.

If absolute paths are desirable in some use cases, providing a CLI option to toggle between this and their relative equivalents would be beneficial to reducing external tooling requirements.

[azu]

If the usecase is only GitHub problem matchers, we may create new formatter like eslint-stylish or github-actions

• built-in: https://github.com/textlint/textlint/tree/master/packages/%40textlint/linter-formatter
• Custom Formatter

The current stylish format is a little different from eslint's stylish.
(textlint add ✔ to the resulting output when it is fixable. I've seen related blog https://qiita.com/nanakenashi/items/1797bedfa343833173f2)

[azu]

Of course, It is good that we think about relative path outputs options.

Related ESLint Issue

• Output relative paths rather than absolute paths · Issue #13376 · eslint/eslint
  • Accessing cwd from formatters by mysticatea · Pull Request #57 · eslint/rfcs
  • Update: pass cwd to formatters (refs eslint/rfcs#57) by mysticatea · Pull Request #13392 · eslint/eslint

[kimburgess]

While the stylish formatter has the incompatibility you note, compact does look to play nicely with eslint-compact.

It looks like the absolute paths may be compatible with the default matchers available in Actions, but have potentially hit another issue (actions/toolkit#810), unrelated to Textlint.

There are other cases where relative paths are useful so supporting that would be a wonderful feature.

[azu]

There are other cases where relative paths are useful so supporting that would be a wonderful feature.

Yes, It is the best result.
However, textlint has --output-file flag. --output-file flag may make it difficult to output relative file path.

Probably, we need to pass some missing info like that is output-file path and cwd to formatted.

📝 tsuyoshicho/action-textlint provide another way for review comments on GitHub.