Setup NPM workspaces

[akshay-ap]

Fixes #146

Summary: This PR proposes use of NPM workspaces which will work as a monorepo where the packages (Safe modules)
would be stored in modules directory. The root package.json of the project should store all the shared dependencies (code formatting, linting, and possibly typescript version as well).

Changes in PR:

• Remove modules:

  • dutchx_seller
  • recurring_transfers

• Move below modules to modules/ directory which is marked as a workspaces directory in root package.json

  • allowances
  • 4337
  • 4337-gas-metering (though this is not another module). Perhaps this directory should be in packages/ directory?

• The root package.json contains dependencies related to code formatting and linting (eslint and prettier) instead of each of the package having individual configurations and dependency versions

• Changes in allowances modules:

  • Uses Safe contracts 1.4.1 version

• Changes in github workflow files:

  • Update working directory
  • Update paths wherever required for the workflow to pass
  • Update npm commands in each workflow file to consider appropriate workspace

• Update README.md:

  • Remove references to dutchx_seller module
  • Update paths of existing modules

[coveralls]

Pull Request Test Coverage Report for Build 7503993801

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 85.093%

---

Totals
Change from base Build 7503869444:	0.0%
Covered Lines:	100
Relevant Lines:	107

---

💛 - Coveralls

[mmv08]

It looks like prettier-plugin-solidity isn't included in the root dependency list and is nested in one of the package's dependencies. Other than that, it looks good so far.

[mmv08]

One bug I found: the fmt command defined globally doesn't respect the .prettierignore file of individual packages. I ran it, and it formatted the FCL files despite being explicitly ignored in the package.

It seems like it's a long-awaited feature: prettier/prettier#4081

For now, I'd suggest:

1. Define the fmt command in each package that will take into account all the package-specific configuration
2. Keep the global command for formatting everything but packages (markdown, GitHub actions, package.json, etc.)

[akshay-ap]

One bug I found: the fmt command defined globally doesn't respect the .prettierignore file of individual packages. I ran it, and it formatted the FCL files despite being explicitly ignored in the package.

It seems like it's a long-awaited feature: prettier/prettier#4081

For now, I'd suggest:

1. Define the fmt command in each package that will take into account all the package-specific configuration
2. Keep the global command for formatting everything but packages (markdown, GitHub actions, package.json, etc.)

Here 1d03625.
Should we also setup a github workflow that verifies files in root directory other than packages/?

[mmv08]

One bug I found: the fmt command defined globally doesn't respect the .prettierignore file of individual packages. I ran it, and it formatted the FCL files despite being explicitly ignored in the package.
It seems like it's a long-awaited feature: prettier/prettier#4081
For now, I'd suggest:

1. Define the fmt command in each package that will take into account all the package-specific configuration
2. Keep the global command for formatting everything but packages (markdown, GitHub actions, package.json, etc.)

Here 1d03625. Should we also setup a github workflow that verifies files in root directory other than packages/?

This doesn't check the formatting in packages (point 1 from my comment), does it?

[akshay-ap]

One bug I found: the fmt command defined globally doesn't respect the .prettierignore file of individual packages. I ran it, and it formatted the FCL files despite being explicitly ignored in the package.
It seems like it's a long-awaited feature: prettier/prettier#4081
For now, I'd suggest:

1. Define the fmt command in each package that will take into account all the package-specific configuration
2. Keep the global command for formatting everything but packages (markdown, GitHub actions, package.json, etc.)

Here 1d03625. Should we also setup a github workflow that verifies files in root directory other than packages/?

This doesn't check the formatting in packages (point 1 from my comment), does it?

When npm ci is executed from root of the project, packages directory will be ignored in this commit.

Each of the package already has its own fmt command so, package specific formatting can be done by specifying workspace name parameter e.g. npm run fmt -w modules/4337.

[mmv08]

One bug I found: the fmt command defined globally doesn't respect the .prettierignore file of individual packages. I ran it, and it formatted the FCL files despite being explicitly ignored in the package.
It seems like it's a long-awaited feature: prettier/prettier#4081
For now, I'd suggest:

1. Define the fmt command in each package that will take into account all the package-specific configuration
2. Keep the global command for formatting everything but packages (markdown, GitHub actions, package.json, etc.)

Here 1d03625. Should we also setup a github workflow that verifies files in root directory other than packages/?

This doesn't check the formatting in packages (point 1 from my comment), does it?

When npm ci is executed from root of the project, packages directory will be ignored in this commit.

Each of the package already has its own `fmt` command so, package specific formatting can be done by specifying workspace name parameter e.g. `npm run fmt -w modules/4337`.

Yes, but how would it be used? I'd expect the ci to check package specific + global formatting, so npm run fmt:global and npm run fmt for packages

Also I accidentally edited your message instead of replying, sorry 🤦

[akshay-ap]

Yes, but how would it be used?

I suggested to have a github action for global checking here. What you suggested is even better. Added in this commit

[mmv08]

Yes, but how would it be used?

I suggested to have a github action for global checking here. What you suggested is even better. Added in this commit

But this executes a check only on the global level without a check on the package level, or am I missing anything? Should it be npm run fmt:global-check && npm run fmt:check ?

[akshay-ap]

But this executes a check only on the global level without a check on the package level, or am I missing anything? Should it be npm run fmt:global-check && npm run fmt:check ?

I added ci.yml to contain only global checks and not package specific checks because they are already setup in each package (module) specific github workflow

[mmv08]

But this executes a check only on the global level without a check on the package level, or am I missing anything? Should it be npm run fmt:global-check && npm run fmt:check ?

I added ci.yml to contain only global checks and not package specific checks because they are already setup in each package (module) specific github workflow

Ahh, makes sense, my bad. All good then

[mmv08]

My bad, I created a bunch of conflicts here. Will resolve them