fix: issue while running typescript files by vaibhavsingh97 · Pull Request #3316 · nightwatchjs/nightwatch

vaibhavsingh97 · 2022-07-30T08:42:08Z

Fixes: #3312
Thanks in advance for your contribution. Please follow the below steps in submitting a pull request, as it will help us with reviewing it quicker.

Create a new branch from master (e.g. features/my-new-feature or issue/123-my-bugfix);
If you're fixing a bug also create an issue if one doesn't exist yet;
If it's a new feature explain why do you think it's necessary. Please check with the maintainers beforehand to make sure it is something that we will accept. Usually we only accept new features if we feel that they will benefit the entire community;
Please avoid sending PRs which contain drastic or low level changes. If you are certain that the changes are needed, please discuss them beforehand and indicate what the impact will be;
If your change is based on existing functionality please consider refactoring first. Pull requests that duplicate code will most likely be ignored;
Do not include changes that are not related to the issue at hand;
Follow the same coding style with regards to spaces, semicolons, variable naming etc.;
Always add unit tests - PRs without tests are most of the times ignored.

beatfactor

Remove ts-node as a main dependency. See also #3312 (comment)

beatfactor · 2022-08-02T11:26:37Z

@vaibhavsingh97 any updates here?

beatfactor · 2022-08-02T21:06:14Z

-  Nightwatch.cli(function(argv) {
+  Nightwatch.cli(function (argv) {
+    const projectTsFilePath = findTSConfigFile();
+    if (projectTsFilePath !== '') {


I actually missed this before, but we also need to check for the disable_typescript setting, which might mean that we need to move all this into the CLIRunner class after we parse the settings.

beatfactor · 2022-08-02T21:07:16Z

+    const projectTsFileLocation2 = path.join(process.cwd(), 'tsconfig.nightwatch.json');
+    if (Utils.fileExistsSync(projectTsFileLocation1)) {
+      return projectTsFileLocation1;
+    } else if (Utils.fileExistsSync(projectTsFileLocation2)) {


remove else

beatfactor · 2022-08-02T21:08:02Z

+        project: projectTsFile
+      });
+    } catch (err) {
+      Logger.error(err);


here we can check if ts-node has been installed in the current project and if not, display the appropriate error message.

beatfactor · 2022-08-02T21:10:19Z

+  static findTSConfigFile() {
+    const projectTsFileLocation1 = path.join(process.cwd(), 'nightwatch', 'tsconfig.json');
+    const projectTsFileLocation2 = path.join(process.cwd(), 'tsconfig.nightwatch.json');
+    if (Utils.fileExistsSync(projectTsFileLocation1)) {


We can actually add a new setting called tsconfig_path (empty by default) so users can set that to whatever they want, in which case they can re-use the existing tsconfig file if they want to. If this property is set, then it should take precedence.

@vaibhavsingh97 any progress with adding the tsconfig_path setting?

garg3133 · 2022-08-03T09:52:13Z

+  static findTSConfigFile() {
+    const projectTsFileLocation1 = path.join(process.cwd(), 'nightwatch', 'tsconfig.json');
+    const projectTsFileLocation2 = path.join(process.cwd(), 'tsconfig.nightwatch.json');
+    if (Utils.fileExistsSync(projectTsFileLocation1)) {
+      return projectTsFileLocation1;
+    } else if (Utils.fileExistsSync(projectTsFileLocation2)) {
+      return projectTsFileLocation2;
+    }
+
+    return '';
+  }


Suggested change

static findTSConfigFile() {

const projectTsFileLocation1 = path.join(process.cwd(), 'nightwatch', 'tsconfig.json');

const projectTsFileLocation2 = path.join(process.cwd(), 'tsconfig.nightwatch.json');

if (Utils.fileExistsSync(projectTsFileLocation1)) {

return projectTsFileLocation1;

} else if (Utils.fileExistsSync(projectTsFileLocation2)) {

return projectTsFileLocation2;

}

return '';

}

static findTSConfigFile() {

const allowedFileLocation = [

path.join('nightwatch', 'tsconfig.json'),

'tsconfig.nightwatch.json'

];

const filesPresent = allowedFileLocation

.map((fileLocation) => path.join(process.cwd(), fileLocation))

.filter((filePath) => Utils.fileExistsSync(filePath));

return filesPresent[0] || '';

}

I am in favour of the existing implementation which is a bit simpler and easier to understand. Besides, .filter() will search the whole array even if the first file is found. We should use Array.some() instead.

garg3133 · 2022-08-03T10:14:49Z

+    const projectTsFilePath = findTSConfigFile();
+    if (projectTsFilePath !== '') {
+      loadTSNode(projectTsFilePath);
+    }


Suggested change

const projectTsFilePath = findTSConfigFile();

if (projectTsFilePath !== '') {

loadTSNode(projectTsFilePath);

}

const isTypescriptProject = Utils.fileExistsSync(path.join(process.cwd(), 'tsconfig.json');

if (isTypescriptProject) {

const projectTsFilePath = findTSConfigFile();

if (projectTsFilePath !== '') {

loadTSNode(projectTsFilePath);

} else {

console.log('You can now run TS tests directly using Nightwatch.\nFollow this doc to learn more.');

}

}

^ This will also help in cases where a user has mistakenly deleted the nightwatch/tsconfig.json file and is now trying to run ts test file but is unable to do so (because we are not loading ts-node anymore).

beatfactor · 2022-08-17T14:14:47Z

  }

+  static get CONFIG_FILE_TS() {
+    return './nightwatch.conf.ts';


@vaibhavsingh97 we need a test that checks for this.

beatfactor · 2022-08-17T14:22:08Z

+      return path.resolve(CliRunner.CONFIG_FILE_CJS);
+    }
+    // TODO: check for both the `nightwatch/tsconfig.json` and `tsconfig.nightwatch.json`
+    if (Utils.fileExistsSync(path.resolve('tsconfig.nightwatch.json'))) {


should be refactored into a usingTS constant, similarly to the usingESM one above and I think we should also check if CliRunner.CONFIG_FILE_TS exists, because you can use a .js or .json config file even if you are using TS.

@garg3133 do we create the nightwatch.conf.ts from the init tool?

beatfactor · 2022-09-16T07:37:47Z

          throw new Error('Does not exist');
        }

+        if (module === './nightwatch.conf.ts'){


the failures on windows are because of this.

beatfactor · 2022-09-16T07:40:45Z

+  loadTypescriptTranspiler() {
+    const isTypescriptProject = Utils.fileExistsSync(path.join(process.cwd(), 'tsconfig.json'));
+    if (isTypescriptProject) {
+      Logger.info('Now you can run TS tests directly using Nightwatch.\nFollow this document to learn more.');


what document?

@vishalshah133 Need to work on it, I had removed the line for now

literallyMello · 2023-01-03T18:17:00Z

What is the new way to extend/override built in types to add properties that would normally be added to the browser (for example custom_commands browser.myCustomCommand())
Before I could use a nightwatch.d.ts file to do that, but with these changes it tries to execute the nightwatch.d.ts file as a test unless I am doing something wrong. #3541

fix: issue while running typescript files

9c1af13

vaibhavsingh97 marked this pull request as draft July 30, 2022 08:43

Add: typescript basic tests

5841775

vaibhavsingh97 marked this pull request as ready for review July 30, 2022 09:59

vaibhavsingh97 requested a review from a team July 30, 2022 10:00

Vaibhav Singh added 2 commits July 30, 2022 15:52

fix: tests

0902a86

refactor: tests

e9fa2b7

beatfactor requested changes Jul 30, 2022

View reviewed changes

Vaibhav Singh added 3 commits August 2, 2022 20:36

update: ts-node to be dev dependency

da8bbeb

Updated: runnner to accept two different tsconfig

41a8398

update: tests timeout

8b5ca74

beatfactor reviewed Aug 2, 2022

View reviewed changes

Add: support for nightwatch.conf.ts

45fa413

garg3133 reviewed Aug 3, 2022

View reviewed changes

Add: suggested changes

30c75cc

beatfactor reviewed Aug 17, 2022

View reviewed changes

Merge remote-tracking branch 'origin/main' into fix/typescript-run-issue

4eb364a

vaibhavsingh97 marked this pull request as draft August 22, 2022 07:34

Vaibhav Singh added 6 commits August 22, 2022 13:27

Add: load TS config intelligently, and show doc when compiled

e1d2cba

feat: Add tsconfig_path config, & nightwatch conf intelligently

4886e26

Fix: broken tests

11536cc

refactor: tests

173e16b

Add: test for nightwatch.conf.ts

52afc79

fix: test

e38ac84

vaibhavsingh97 marked this pull request as ready for review August 22, 2022 11:27

vaibhavsingh97 requested a review from beatfactor August 22, 2022 11:27

Vaibhav Singh added 2 commits August 22, 2022 17:00

refactor code

c4fc48d

Merge remote-tracking branch 'origin/main' into fix/typescript-run-issue

0373021

beatfactor reviewed Sep 16, 2022

View reviewed changes

swrdfish and others added 3 commits September 16, 2022 23:42

fix windows build

168f202

Merge branch 'main' into fix/typescript-run-issue

877deea

Merge remote-tracking branch 'origin/main' into fix/typescript-run-issue

938fee1

vaibhavsingh97 requested a review from beatfactor September 19, 2022 14:28

Vaibhav Singh added 4 commits September 22, 2022 13:32

add: tests for findTSConfigFile

64ed4f2

fix: failed test

56a2349

fix: merge conflict

c157e49

remove: document comment

52cfd08

beatfactor merged commit 92ad22d into nightwatchjs:main Oct 14, 2022

Conversation

vaibhavsingh97 commented Jul 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

beatfactor left a comment

Choose a reason for hiding this comment

Uh oh!

beatfactor commented Aug 2, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

garg3133 Aug 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

beatfactor Aug 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

literallyMello commented Jan 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

vaibhavsingh97 commented Jul 30, 2022 •

edited

Loading

garg3133 Aug 3, 2022 •

edited

Loading

beatfactor Aug 3, 2022 •

edited

Loading