VSCode Create Test File Extension

** This is a fork of https://github.com/paul-mannino/vscode-create-test-file **

This is an extension that adds a command for creating a test file, with a given name and path inferred from a currently open file (or one selected file from the sidebar).

For example, if your application code lives under the app directory in your workspace and your test code lives under the spec folder, you can define rules such that for any file app/foo/bar/filename.rb, you will create or open a file with spec/foo/bar/filename_spec.rb. These settings can be customized for each filetype, and you may create multiple path mappers if you have multiple conventions for where you create tests.

Available commands are:

• Create Test File: Create Test File
• Create Test File: Find Test File
• Create Test File: Go To or From Test File
• Create Test File: Clean Go to or From Cache

Suggested keyboard shortcut:

• ctrl+shift+u

If you are using ubuntu you will need to disable the ibus emoji macro to free up this shortcut. See https://superuser.com/a/1392682/150253

Features

1. Full path mutation support via JS regex replace. Given a path pattern and a test file pattern, you get workspaceRelativePath.replace(pathPattern, testFilePattern); anything you can write via https://regex101.com/ will work.

2. Pattern matched filename mutatation. Format is {filename}.{extension} both filename and extension are optional. So if you want to change the extension completely you could do

"createTestFile.languages": {
    "[vue]": {
        "createTestFile.nameTemplate": "{filename}.test.js"
    }
}

which for Vue.js files, if file is foo.vue, will create foo.test.js

3. If you want workspace specific behavior, this is built in to VSCode itself. You can activate this feature by editing appropriate settings in the project relative ./.vscode/settings.json file. See https://code.visualstudio.com/docs/getstarted/settings#_workspace-settings

4. Quick swapping between test and non-test files. This is still a work in progress! You will get an error if you try to swap, and start from the test file. To safely use this feature you need to start from a non-test file, then trigger the "Go to or from test file" action. After that, the connection between the test and non-test file will be established, an you can swap between the two files.

Extension Settings

For pattern replacement conventions see Specifying a string as the replacement

// Basic settings
"createTestFile.nameTemplate": "{filename}_spec.{extension}", // If file is named foo.bar, will create test named foo_spec.bar
"createTestFile.languages": {
    "[javascript]": {
        "createTestFile.nameTemplate": "{filename}.test.{extension}" // For javascript, if file is foo.js, will create foo.test.js
    }
},
// NOTE: Only the first rule to match the file path will be used!
// Rules will be searched in the order they are defined.
"createTestFile.pathMaps": [
    {
        // Defines rule such that any file under app/ will have a test file created under spec/
        "pathPattern": "app/?(.*)?", // Regex file path matcher
        "testFilePathPattern": "spec/$1" // $1, $2, etc. will be replaced with the matching text from the pathPattern
    }
],
// Matchers that determine whether a file is a test file or not.
// You probably don't need to edit this, but if you need to you can.
isTestFileMatchers: [
    "^(?:test|spec)s?/", // matches paths that start with either "test" or "spec" followed by an optional "s", and finally ending with a forward slash "/"
    "/(?:test|spec)s?/", // matches paths that have a segment of test(s) or spec(s) and is bracketed with forward slashes "/"
    "/?(?:test|spec)s?_",  // matches paths that start an optional forward slash "/" then with either "test" or "spec" followed by an optional "s", and finally ending with a _
    "/?_(?:test|spec)s?", // same as above, but leading "_"
    "/?\\.(?:test|spec)s?", // same as above but with leading "."
    "/?(?:test|spec)s?\\." // same as above but with trailing "."
]

Known Issues

1. While path replacement has full regex support, filename replacement does not support full regex replacement.

Why didn't I make filename replacement support full regex? Because the regex pattern for parsing out the file extension would need be more complex than /^(\/?|)([\s\S]*?)((?:\.{1,2}|[^\/]+?|)(\.[^.\/]*|))(?:[\/]*)$/ See https://github.com/jinder/path/blob/7fbaede3ca9d224494cbdd47d7ca803ee96d2055/path.js#L420 and https://github.com/jinder/path/blob/7fbaede3ca9d224494cbdd47d7ca803ee96d2055/path.js#L91

2. You will get an error if you try to swap to a source file, and you start from the test file. Future work will either provide a fuzzy search and a quick pick list of possible source files from a given test file, or will reduce the path replacement complexity until path replacement becomes a fully reversible process.

Release Notes

See CHANGELOG

Development and Testing

Generally you would run the project via F5 in VSCode.

Alternatively, see package.json -> scripts for other commands.

e.g.

• npm run test

File Access in Tests

The test config opens the app with ./out/tmp/example-workspace/ as the default workspace. File manipulation tests can be performed in this folder. The directory is copied from the project ./src/test/example-workspace directory as part of the npm run test command.

FUTURE: investigate continuous integration and headless testing https://code.visualstudio.com/api/working-with-extensions/continuous-integration#azure-pipelines

Publishing

See https://code.visualstudio.com/api/working-with-extensions/publishing-extension for full details. The following is a quick refresher:

1. (as needed) npm install -g @vscode/vsce
2. vsce package
3. vsce publish

You might need to periodically refresh your azure dev ops api key.

Published to https://marketplace.visualstudio.com/items?itemName=klondikemarlen.create-test-file