[jest-plugin-fs] [docs] Poor usage docs - please post a better example

[kristianmandrup]

It is unclear how to use this plugin from the example code which does not use fs directly at any point, but only references an undeclared FileWriter, which I assume uses the mocked fs behind the scenes. Please improve the usage docs. For now I'll have to deep dive into the code and tests...

Also, I see you are using some of your other plugins such as set without mention.
"Too much magic" to be easy to understand for an "outsider"

fs.spec.js

[kristianmandrup]

The following taken directly from the spec is WAY more informative :)

/* eslint-disable no-undef */
describe('fs', () => {
  beforeEach(() => fs.mock());
  afterEach(() => fs.restore());

  context('with new file', () => {
    set('filename', () => 'some/path/to/file.txt');
    beforeEach(() => fsExtra.outputFileSync(filename, 'test-content'));

    it('should create the new file', () => {
      expect(fsExtra.readFileSync(filename, 'utf8')).toEqual('test-content');
    });
  });

  context('with nested directories', () => {
    set('filesystem', () => ({
      test: {
        directory: {
          nested: {
            file: 'hello there',
          },
        },
      },
    }));

    beforeEach(() => fs.mock(filesystem));

    it('should create nested directories', () => {
      expect(
        fsExtra.readFileSync('/test/directory/nested/file', 'utf8'),
      ).toEqual('hello there');
    });
  });
  });

[negativetwelve]

Hi @kristianmandrup, this is great feedback, thank you!

I was in a rush to make this package functional for a work issue and didn't get a chance to document it well. I'd love if you made a PR to update the README with more useful information. Anything you can contribute would be appreciated 😄

Otherwise, I'll try to get to this in the next week. I didn't realize people started using these plugins and I have a lot of documentation to write to make this more accessible

[kristianmandrup]

Well, you could just copy paste the snippet I made in my Issue in place of the current snippet on the Readme which is pretty hard to understand since it implies a lot of "context".